Skip to content

Commit f818cd5

Browse files
authored
Merge pull request #5 from commandlayer/codex/align-documentation-for-protocol-commons-v1.1.0
Align docs: declare v1.1.0 as active in‑repo (pre‑release) and scope v1.0.0 as last pinned canonical release
2 parents a48dc23 + 0d779ed commit f818cd5

File tree

5 files changed

+226
-149
lines changed

5 files changed

+226
-149
lines changed

COMPLIANCE.md

Lines changed: 40 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,22 @@ Compliance covers semantics and schema integrity only—identity bindings are go
2323

2424
---
2525

26-
## 2. Versioning & Immutability
26+
## 2. Version-Aware Compliance Status
27+
28+
Compliance claims MUST identify the version they apply to.
29+
30+
Current repository status:
31+
32+
- **v1.1.0** — current in-repo schema family; CID publication still pending
33+
- **v1.0.0** — last fully pinned canonical release
34+
35+
A system MAY claim **v1.1.0 schema compatibility** if it validates and enforces the published v1.1.0 schemas.
36+
37+
A system MUST NOT claim **fully pinned canonical v1.1.0 release compliance** until the v1.1.0 CID and provenance record are published.
38+
39+
---
40+
41+
## 3. Versioning & Immutability
2742

2843
For any directory `schemas/vX.Y.Z/`:
2944

@@ -35,39 +50,39 @@ No in-place edits to:
3550

3651
Any semantic change requires:
3752
- New version directory
38-
- Updated CIDs + checksums
53+
- Updated CIDs + checksums for canonical releases
3954
- Logged update in `RESOLUTION.md`
4055
- Governance approval
4156

4257
Mutating a published version is **not compliant**.
4358

4459
---
4560

46-
## 3. JSON Schema Requirements
61+
## 4. JSON Schema Requirements
4762

4863
All Protocol-Commons schemas MUST:
4964

5065
- Use JSON Schema Draft 2020-12
5166
- Validate under **Ajv strict mode**
5267
- Use deterministic HTTPS-resolvable `$id` values matching SPEC.md
53-
- Enforce verb-specific input + receipt contract
68+
- Enforce the version-specific input + receipt contract
5469

5570
Loose validation or altered `$id` resolution is **not compliant**.
5671

5772
---
5873

59-
## 4. CIDs & Checksums
74+
## 5. CIDs & Checksums
6075

61-
Each release MUST:
76+
Each canonical release MUST:
6277

6378
- Pin the entire version folder to IPFS
6479
- Provide SHA-256 checksums
6580
- Publish `manifest.json`
6681

6782
Compliance requires:
6883

69-
- `cl.cid.schemas` resolves to the correct CID
70-
- IPFS mirrors match HTTP mirrors exactly
84+
- Canonical TXT/CID bindings only for fully published releases
85+
- IPFS mirrors match HTTP mirrors exactly for pinned releases
7186

7287
Consumers SHOULD verify `checksums.txt` against the published schema
7388
artifacts prior to use.
@@ -77,8 +92,11 @@ canonical compliance, and MUST reject mismatches.
7792

7893
Mismatch = **integrity failure**
7994

95+
For v1.1.0 specifically, the schemas and checksums can still be validated locally, but the release MUST be described as pre-release until its CID publication is complete.
96+
97+
---
8098

81-
## 5. Security & Privacy
99+
## 6. Security & Privacy
82100

83101
Schemas are **semantic infrastructure**, not application output.
84102

@@ -91,7 +109,7 @@ Security incidents MUST follow `SECURITY.md`.
91109

92110
---
93111

94-
## 6. Governance Traceability
112+
## 7. Governance Traceability
95113

96114
Every canonical change MUST be reflected in:
97115
- `RESOLUTION.md` (what + why + who)
@@ -101,18 +119,22 @@ An artifact **without a governance trail** is not canonical.
101119

102120
---
103121

104-
## 7. Ecosystem Alignment
122+
## 8. Ecosystem Alignment
105123

106124
Commons-compliant implementations SHOULD:
107125

108126
- Support ERC-8004 discovery where relevant
109-
- Enforce canonical x402 envelope + trace rules
127+
- Apply only the requirements that are normative for the version they implement
128+
129+
For v1.0.0 legacy implementations, that can include older `x402` envelope and `trace` requirements.
130+
131+
For v1.1.0 implementations, those older `x402` and `trace` requirements are **not automatically normative** unless another layer explicitly adopts them outside the Commons schemas.
110132

111-
Divergence is allowed — but **compliance claims then MUST NOT be made**.
133+
Divergence from the version-specific Commons contract means **compliance claims then MUST NOT be made**.
112134

113135
---
114136

115-
## 8. Deviation Handling
137+
## 9. Deviation Handling
116138

117139
If a deviation is found:
118140

@@ -123,15 +145,16 @@ If a deviation is found:
123145

124146
---
125147

126-
## 9. Compliance Checklist
148+
## 10. Compliance Checklist
127149

128-
You may claim **Protocol-Commons compliant** if:
150+
You may claim **Protocol-Commons compliant** for a specific version if:
129151

130152
- Strict Ajv validation enforced
131153
- Version directories treated as immutable
132154
- `$id` URLs resolve correctly
133-
- CIDs and checksums match content
155+
- CIDs and checksums match content when the version is claimed as canonical and pinned
134156
- Changes logged and signed
135157
- ENS TXT duties respected per SPEC.md
158+
- Version status is described accurately as pinned canonical or pre-release
136159

137160
If uncertain → treat the implementation as **experimental**.

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
**The canonical semantic contract for autonomous agents.**
44
*Verbs, schemas, and validation — or nothing interoperates.*
55

6-
[![Schemas](https://img.shields.io/badge/Schemas-Stable%20v1.1.0-brightgreen)](https://github.com/commandlayer/protocol-commons)
6+
[![Schemas](https://img.shields.io/badge/Schemas-v1.1.0%20candidate-yellow)](https://github.com/commandlayer/protocol-commons)
77
[![NPM Version](https://img.shields.io/npm/v/@commandlayer/commons)](https://www.npmjs.com/package/@commandlayer/commons)
88
[![CI Status](https://img.shields.io/github/actions/workflow/status/commandlayer/protocol-commons/validate.yml?branch=main&label=CI)](https://github.com/commandlayer/protocol-commons/actions/workflows/validate.yml)
99
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/commandlayer/protocol-commons/blob/main/LICENSE)
@@ -26,10 +26,11 @@ Protocol-Commons is the foundation for portable machine intent: a stable set of
2626

2727
> **Integrity Notice — Protocol-Commons v1.1.0**
2828
>
29-
> Canonical schemas are pinned and immutable:
29+
> `schemas/v1.1.0/commons` is the current in-repo schema family, but its release CID is still pending:
3030
> `schemas/v1.1.0/commons` — CID: `TBD (pre-release)`
3131
>
32-
> Historical v1.0.0 artifacts remain in-repo for compatibility and verification.
32+
> `v1.0.0` remains the last fully pinned canonical release:
33+
> `schemas/v1.0.0/` — CID: `bafybeigvf6nkzws7dblos74dqqjkguwkrwn4a2c27ieygoxmgofyzdkz6m`
3334
>
3435
> Verify integrity locally:
3536
> ```bash
@@ -160,7 +161,9 @@ console.log(validate.errors ?? []);
160161
161162
## Commons v1.1.0
162163
163-
Commons v1.1.0 introduces a simplified, flat schema surface for general-purpose agent actions.
164+
Commons v1.1.0 is the active schema family in this repository.
165+
166+
It is ready for schema validation and local integration work, but its release provenance is still **pre-release** until a real CID is published.
164167
165168
- Each request schema is standalone
166169
- Each receipt schema is standalone
@@ -349,10 +352,11 @@ Commons gives upper layers a stable meaning layer to build around.
349352
350353
## Status
351354
352-
**Stable — v1.1.0 current**
355+
**v1.1.0 — active schema family, release CID pending**
353356
354-
- `v1.1.0` is the current flat Commons layout
355-
- `v1.0.0` remains in-repo as a legacy schema family
357+
- `v1.1.0` is the current flat Commons layout in this repo
358+
- `v1.0.0` remains the last fully pinned canonical release
359+
- Do not describe `v1.1.0` provenance as fully canonical until pinning is complete
356360
357361
---
358362

SCHEMAS.md

Lines changed: 36 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,20 @@ Once published, a version directory is immutable.
2020

2121
---
2222

23-
## 2. Directory Layout
23+
## 2. Version Status
2424

25-
### Current layout: v1.1.0
25+
This repository currently ships:
26+
27+
- **v1.1.0** as the active in-repo schema family
28+
- **v1.0.0** as the historical and last fully pinned canonical release
29+
30+
Because `manifest.json` still reports the v1.1.0 schema CID as pending, documentation MUST describe v1.1.0 as **pre-release for provenance/pinning status** until a real CID is published.
31+
32+
---
33+
34+
## 3. Directory Layout
35+
36+
### Current in-repo layout: v1.1.0
2637

2738
```text
2839
schemas/v1.1.0/
@@ -32,7 +43,7 @@ schemas/v1.1.0/
3243
└── <verb>.receipt.schema.json
3344
```
3445

35-
### Legacy layout: v1.0.0
46+
### Historical pinned layout: v1.0.0
3647

3748
```text
3849
schemas/v1.0.0/
@@ -57,7 +68,7 @@ schemas/v1.0.0/
5768

5869
---
5970

60-
## 3. Canonical Verb Set
71+
## 4. Canonical Verb Set
6172

6273
| Verb | Purpose |
6374
|------|---------|
@@ -79,7 +90,7 @@ Each verb MUST define exactly:
7990

8091
---
8192

82-
## 4. Deterministic `$id` Contract
93+
## 5. Deterministic `$id` Contract
8394

8495
### v1.1.0 request schemas
8596

@@ -107,13 +118,13 @@ https://commandlayer.org/schemas/v1.1.0/commons/summarize/summarize.receipt.sche
107118

108119
### Legacy v1.0.0 note
109120

110-
Legacy v1.0.0 schemas retain their older nested `$id` patterns and `_shared` references. Those patterns are not the v1.1.0 contract.
121+
Legacy v1.0.0 schemas retain their older nested `$id` patterns and `_shared` references. Those patterns are legacy-only and are not the v1.1.0 contract.
111122

112123
All `$id` values MUST be fully qualified HTTPS URLs.
113124

114125
---
115126

116-
## 5. v1.1.0 Request Contract
127+
## 6. v1.1.0 Request Contract
117128

118129
Every v1.1.0 request MUST include:
119130

@@ -130,7 +141,7 @@ v1.1.0 requests do not use nested request objects, `x402`, `trace`, or `actor` f
130141

131142
---
132143

133-
## 6. v1.1.0 Receipt Contract
144+
## 7. v1.1.0 Receipt Contract
134145

135146
Every v1.1.0 receipt MUST include:
136147

@@ -159,21 +170,21 @@ The trust model is limited to signer attestation plus request/result hash refere
159170

160171
---
161172

162-
## 7. Legacy v1.0.0 Scope
173+
## 8. Legacy v1.0.0 Scope
163174

164-
v1.0.0 remains in-repo for compatibility and historical verification.
175+
v1.0.0 remains in-repo for compatibility, historical verification, and canonical pin auditing.
165176

166177
Its schemas use:
167178

168179
- `_shared` helper schemas
169180
- nested `requests/` and `receipts/` folders
170-
- older envelope conventions
181+
- older envelope conventions including `x402` and `trace`
171182

172-
Documentation and tooling MUST distinguish that legacy structure from v1.1.0.
183+
Documentation and tooling MUST distinguish that legacy structure from v1.1.0 and MUST NOT present those legacy fields as universally normative.
173184

174185
---
175186

176-
## 8. Versioning Rules
187+
## 9. Versioning Rules
177188

178189
Once published under a version directory such as `schemas/v1.1.0/`, the following actions are prohibited:
179190

@@ -186,7 +197,7 @@ Any change requires a new version directory.
186197

187198
---
188199

189-
## 9. Validation Requirements
200+
## 10. Validation Requirements
190201

191202
CI and local validation SHOULD enforce strict schema compilation behavior equivalent to:
192203

@@ -210,7 +221,7 @@ All shipped valid and invalid examples MUST match the version-specific schema la
210221

211222
---
212223

213-
## 10. Examples
224+
## 11. Examples
214225

215226
Examples are maintained per version.
216227

@@ -232,7 +243,7 @@ examples/v1.0.0/commons/<verb>/
232243

233244
---
234245

235-
## 11. Provenance & Integrity
246+
## 12. Provenance & Integrity
236247

237248
Integrity is tracked by:
238249

@@ -245,13 +256,19 @@ Current v1.1.0 schema CID status:
245256
TBD (pre-release)
246257
```
247258

248-
Resolvers and auditors MUST reject mismatched artifacts.
259+
Last pinned canonical release CID:
260+
261+
```text
262+
v1.0.0 → bafybeigvf6nkzws7dblos74dqqjkguwkrwn4a2c27ieygoxmgofyzdkz6m
263+
```
264+
265+
Resolvers and auditors MUST reject mismatched artifacts and MUST distinguish between a shipped schema family and a fully pinned canonical release.
249266

250267
---
251268

252-
## 12. Contact
269+
## 13. Contact
253270

254271
- dev@commandlayer.org
255272
- PGP 5016 D496 9F38 22B2 C5A2 FA40 99A2 6950 197D AB0A
256273

257-
**Status:** Stable `v1.1.0` current; `v1.0.0` legacy
274+
**Status:** v1.1.0 active in-repo schema family with pending CID; v1.0.0 retained as the historical pinned canonical release.

0 commit comments

Comments
 (0)