Skip to content

Commit 4424498

Browse files
committed
Rename format from Codex to CDX (Content-addressed Document eXchange)
The format shared the name "Codex" with OpenAI's coding-agent platform, which now dominates developer/AI search and is broadening toward document workflows. Rename to CDX to restore discoverability and a distinct identity. Changes: - Brand/prose: Codex -> CDX; introduce the expansion "Content-addressed Document eXchange" at first mention; drop redundant "CDX Document Format" - Manifest spec-version key: "codex" -> "cdx" - MIME types: application/vnd.codex* -> application/vnd.cdx* - Extension namespace IDs: codex.* -> cdx.* (8 extensions) - Schema $id and $ref host: https://codex.document -> https://cdx.dev - Tooling: generate-template.ts (emits cdx key/IDs) and check-example-coverage.ts (extension-id matcher) updated Intentionally unchanged: the .cdx file extension (already name-independent); the GitHub repo/org name and repo-path URLs (separate admin action; GitHub auto-redirects); package.json name; docs/archive/** (historical record). Validation: schemas compile, all 11 example documents validate, 71/71 cross-references resolve, 8/8 extensions and 15/15 schemas covered. Note: https://cdx.dev is a placeholder schema namespace (JSON Schema $id URIs need not resolve); repoint at a controlled domain if desired.
1 parent 00a5532 commit 4424498

70 files changed

Lines changed: 282 additions & 282 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

CHANGELOG.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changelog
22

3-
All notable changes to the Codex file format specification.
3+
All notable changes to the CDX file format specification.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
66

@@ -19,14 +19,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
1919
- Highlight annotation documentation in collaboration extension (Section 4.7)
2020

2121
#### Extensions
22-
- **Academic** (`codex.academic`) - Theorems, proofs, exercises, algorithms, equation groups
23-
- **Collaboration** (`codex.collaboration` v0.2) - CRDT integration, comments, change tracking, presence
24-
- **Forms** (`codex.forms`) - Interactive form fields with validation
25-
- **Legal** (`codex.legal`) - Citations, Table of Authorities, court captions, signature blocks
26-
- **Phantoms** (`codex.phantoms`) - Invisible structural elements for complex layouts
27-
- **Presentation** (`codex.presentation`) - Advanced typography, master pages, print features
28-
- **Security** (`codex.security`) - Digital signatures, encryption, redaction, scoped signatures
29-
- **Semantic** (`codex.semantic`) - Bibliography, footnotes, glossary, entity markup, JSON-LD
22+
- **Academic** (`cdx.academic`) - Theorems, proofs, exercises, algorithms, equation groups
23+
- **Collaboration** (`cdx.collaboration` v0.2) - CRDT integration, comments, change tracking, presence
24+
- **Forms** (`cdx.forms`) - Interactive form fields with validation
25+
- **Legal** (`cdx.legal`) - Citations, Table of Authorities, court captions, signature blocks
26+
- **Phantoms** (`cdx.phantoms`) - Invisible structural elements for complex layouts
27+
- **Presentation** (`cdx.presentation`) - Advanced typography, master pages, print features
28+
- **Security** (`cdx.security`) - Digital signatures, encryption, redaction, scoped signatures
29+
- **Semantic** (`cdx.semantic`) - Bibliography, footnotes, glossary, entity markup, JSON-LD
3030

3131
#### Profiles
3232
- Simple Documents profile for recreational reading

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to Codex Document Format
1+
# Contributing to CDX
22

3-
Thank you for your interest in contributing to the Codex Document Format specification.
3+
Thank you for your interest in contributing to the CDX specification.
44

55
## How to Contribute
66

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Codex Document Format
1+
# CDX
22

33
[![Validate Schemas](https://github.com/Entrolution/codex-file-format-spec/actions/workflows/validate-schemas.yml/badge.svg)](https://github.com/Entrolution/codex-file-format-spec/actions/workflows/validate-schemas.yml)
44
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
55

6-
**An open specification for documents that unify viewing and editing, with modern security and machine readability.**
6+
**CDX — Content-addressed Document eXchange.** An open specification for documents that unify viewing and editing, with modern security and machine readability.
77

88
> Status: Draft Specification (v0.1)
99
@@ -85,7 +85,7 @@ This divide creates workflow friction, format conversion overhead, and lost fide
8585

8686
## Key Feature: Verifiable Provenance
8787

88-
Codex documents form a **cryptographic hash chain** — each document's identity IS its content hash, and each document can reference its parent by hash:
88+
CDX documents form a **cryptographic hash chain** — each document's identity IS its content hash, and each document can reference its parent by hash:
8989

9090
```
9191
doc-v1 (sha256:aaa) ←── doc-v2 (sha256:bbb) ←── doc-v3 (sha256:ccc)
@@ -103,7 +103,7 @@ This enables:
103103

104104
## Key Feature: State-Aware Presentation
105105

106-
Codex uses **progressive enhancement** for presentation — the level of layout precision evolves with document maturity:
106+
CDX uses **progressive enhancement** for presentation — the level of layout precision evolves with document maturity:
107107

108108
| Document State | Presentation Requirement | What's Frozen |
109109
|----------------|-------------------------|---------------|
@@ -164,7 +164,7 @@ The specification is modular:
164164

165165
### Document Structure
166166

167-
A Codex document is a ZIP archive with this structure:
167+
A CDX document is a ZIP archive with this structure:
168168

169169
```
170170
document.cdx
@@ -195,7 +195,7 @@ document.cdx
195195

196196
```json
197197
{
198-
"codex": "0.1",
198+
"cdx": "0.1",
199199
"id": "sha256:a1b2c3...",
200200
"state": "draft",
201201
"content": {
@@ -209,7 +209,7 @@ document.cdx
209209
"type": "paragraph",
210210
"children": [
211211
{ "type": "text", "value": "This is a " },
212-
{ "type": "text", "value": "Codex", "marks": ["bold"] },
212+
{ "type": "text", "value": "CDX", "marks": ["bold"] },
213213
{ "type": "text", "value": " document." }
214214
]
215215
}
@@ -221,8 +221,8 @@ document.cdx
221221
## File Extension and MIME Type
222222

223223
- **Extension**: `.cdx`
224-
- **MIME Type**: `application/vnd.codex+json` (canonical JSON form)
225-
- **Alternative**: `application/vnd.codex` (binary/packed form)
224+
- **MIME Type**: `application/vnd.cdx+json` (canonical JSON form)
225+
- **Alternative**: `application/vnd.cdx` (binary/packed form)
226226

227227
## Roadmap
228228

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ If you find a security issue in the reference implementation ([cdx-core](https:/
2020

2121
This security policy covers:
2222

23-
- The Codex Document Format specification
23+
- The CDX specification
2424
- JSON schemas in this repository
2525
- Example documents in this repository
2626

docs/design-decisions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Design Decisions
22

3-
This document records key design decisions made during the Codex format specification development.
3+
This document records key design decisions made during the CDX format specification development.
44

55
## DD-001: ZIP Container Format
66

@@ -559,7 +559,7 @@ This section captures key strategic insights from early design discussions that
559559
**Build Order**:
560560
1. **cdx-core** (Rust library) — Foundation everything else builds on
561561
2. **cdx-cli** — Dogfoods the core library, essential for tooling development
562-
3. **Pandoc writer** — Markdown → Codex (the academia unlock)
562+
3. **Pandoc writer** — Markdown → CDX (the academia unlock)
563563
4. **Web viewer** — cdx-core compiled to WASM (zero-install demonstration)
564564

565565
**Why Pandoc**: Academics don't adopt new editors, they adopt new export targets. A Pandoc writer fits existing workflows with zero friction for authors.

examples/academic-document/manifest.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
2-
"codex": "0.1",
2+
"cdx": "0.1",
33
"id": "pending",
44
"state": "draft",
55
"created": "2025-01-28T14:00:00Z",
66
"modified": "2025-01-28T14:00:00Z",
77
"extensions": [
88
{
9-
"id": "codex.academic",
9+
"id": "cdx.academic",
1010
"version": "0.1",
1111
"required": false
1212
}

examples/academic-document/metadata/dublin-core.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"description": "A demonstration of academic extension features including theorems, proofs, exercises, and algorithms.",
88
"date": "2025-01-28",
99
"type": "Text",
10-
"format": "application/vnd.codex+zip",
10+
"format": "application/vnd.cdx+zip",
1111
"language": "en",
1212
"rights": "CC BY 4.0"
1313
}

examples/collaboration-document/manifest.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
2-
"codex": "0.1",
2+
"cdx": "0.1",
33
"id": "pending",
44
"state": "draft",
55
"created": "2025-01-28T14:00:00Z",
66
"modified": "2025-01-28T14:00:00Z",
77
"extensions": [
88
{
9-
"id": "codex.collaboration",
9+
"id": "cdx.collaboration",
1010
"version": "0.2",
1111
"required": false
1212
}

examples/collaboration-document/metadata/dublin-core.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"description": "A demonstration of collaboration extension features including comments, suggestions, reactions, and tracked changes with multiple authors.",
88
"date": "2025-01-28",
99
"type": "Text",
10-
"format": "application/vnd.codex+zip",
10+
"format": "application/vnd.cdx+zip",
1111
"language": "en",
1212
"rights": "Confidential"
1313
}

examples/comprehensive-document/content/document.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"children": [
1616
{ "type": "text", "value": "This document demonstrates " },
1717
{ "type": "text", "value": "all block types", "marks": ["bold"] },
18-
{ "type": "text", "value": " supported by the Codex format. It serves as both documentation and a validation test case." }
18+
{ "type": "text", "value": " supported by the CDX format. It serves as both documentation and a validation test case." }
1919
]
2020
},
2121
{
@@ -273,7 +273,7 @@
273273
{
274274
"type": "definitionTerm",
275275
"children": [
276-
{ "type": "text", "value": "Codex" }
276+
{ "type": "text", "value": "CDX" }
277277
]
278278
},
279279
{
@@ -332,7 +332,7 @@
332332
"children": [
333333
{
334334
"type": "text",
335-
"value": "interface CodexDocument {\n version: string;\n blocks: Block[];\n}\n\nfunction validate(doc: CodexDocument): boolean {\n return doc.blocks.every(block => block.type !== undefined);\n}"
335+
"value": "interface CdxDocument {\n version: string;\n blocks: Block[];\n}\n\nfunction validate(doc: CdxDocument): boolean {\n return doc.blocks.every(block => block.type !== undefined);\n}"
336336
}
337337
]
338338
},
@@ -607,7 +607,7 @@
607607
{
608608
"type": "figcaption",
609609
"children": [
610-
{ "type": "text", "value": "Figure: Codex document architecture showing the relationship between content, presentation, and metadata layers." }
610+
{ "type": "text", "value": "Figure: CDX document architecture showing the relationship between content, presentation, and metadata layers." }
611611
]
612612
}
613613
]
@@ -624,8 +624,8 @@
624624
"type": "barcode",
625625
"id": "qr-demo",
626626
"format": "qr",
627-
"data": "https://codex.document/spec",
628-
"alt": "QR code linking to Codex specification",
627+
"data": "https://cdx.dev/spec",
628+
"alt": "QR code linking to CDX specification",
629629
"errorCorrection": "M",
630630
"size": 150
631631
},
@@ -701,7 +701,7 @@
701701
"signer": {
702702
"name": "Jane Smith",
703703
"title": "Technical Lead",
704-
"organization": "Codex Foundation",
704+
"organization": "CDX Foundation",
705705
"email": "jane.smith@example.com"
706706
},
707707
"timestamp": "2025-01-28T14:00:00Z",
@@ -905,7 +905,7 @@
905905
"type": "paragraph",
906906
"id": "conclusion",
907907
"children": [
908-
{ "type": "text", "value": "This document demonstrates all block types defined in the Codex content schema. Each block type serves a specific semantic purpose, enabling reliable machine processing and consistent rendering across implementations." }
908+
{ "type": "text", "value": "This document demonstrates all block types defined in the CDX content schema. Each block type serves a specific semantic purpose, enabling reliable machine processing and consistent rendering across implementations." }
909909
]
910910
}
911911
]

0 commit comments

Comments
 (0)