swaitsandClaude Opus 4.7
d785e35919
Set up the protocol spec as an mdBook and add a GitHub Actions workflow that builds it on every push/PR and deploys to GitHub Pages on main. The repo is now both a machine-readable corpus and a browsable, searchable site. Structure changes (one-time, mechanical): - Rename the spec source directory from `spec/` to `src/` to match mdBook's default convention. All 21 chapter files move; their internal relative cross-links are unchanged. - Add `src/SUMMARY.md` as the mdBook table of contents, grouping chapters under Wire Format, Payloads, Cryptography & Identity, and Routing & Higher-Layer Protocols. - Add `book.toml` at repo root: title, author, search enabled, fold enabled, edit-on-GitHub links, navy theme. - Add `.github/workflows/mdbook.yml`: build on push + PR, deploy on push to main only (configure-pages + upload-pages-artifact + deploy-pages from actions/). - Add `/book/` to .gitignore. Reference updates so the old path is fully retired: - Every `spec_ref` in `corpus/**/*.json` rewritten from `spec/` to `src/` (54 files). - Schema description text and example path in `corpus/schema/test-vector.schema.json`. - `README.md`: prominent link to the published site near the top; "What's Here" updated for the new layout. - `CONTRIBUTING.md`: spec-editing instructions point at `src/` and note the SUMMARY.md requirement. - `CLAUDE.md`: directory-layout notes updated. CHANGELOG.md historical entries intentionally keep their `spec/` paths since those record what the paths were at the time of those commits. After this lands, the user needs to enable GitHub Pages in repo settings with source = "GitHub Actions" (one-time, manual). The workflow will then publish to https://swaits.github.io/meshcore-spec/ on every push to main. Verified locally: `mdbook build` produces a clean book/ tree with all 21 chapters rendered and the SUMMARY-driven sidebar populated. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
98 lines
2.5 KiB
JSON
98 lines
2.5 KiB
JSON
{
|
|
"$schema": "../../schema/test-vector.schema.json",
|
|
"name": "Header - Protocol Versions",
|
|
"spec_ref": "src/02-header.md",
|
|
"protocol_version": 0,
|
|
"description": "Tests encoding of all 4 protocol version values in header bits 6-7. Uses ACK (type=3) with FLOOD routing as a simple baseline.",
|
|
"vectors": [
|
|
{
|
|
"id": "ver-000",
|
|
"description": "Version 0 (V1, current) - bits 6-7 = 00",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 0,
|
|
"payload_type": "ack",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"ack_crc": "00000001"
|
|
}
|
|
},
|
|
"binary": "0D 00 01000000",
|
|
"notes": "Header: (0<<6)|(3<<2)|1 = 0x0D. Version 0 = V1."
|
|
},
|
|
{
|
|
"id": "ver-001",
|
|
"description": "Version 1 (V2, reserved) - bits 6-7 = 01",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 1,
|
|
"payload_type": "ack",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"ack_crc": "00000001"
|
|
}
|
|
},
|
|
"binary": "4D 00 01000000",
|
|
"notes": "Header: (1<<6)|(3<<2)|1 = 0x4D. Version 1 = V2 (reserved)."
|
|
},
|
|
{
|
|
"id": "ver-002",
|
|
"description": "Version 2 (V3, reserved) - bits 6-7 = 10",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 2,
|
|
"payload_type": "ack",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"ack_crc": "00000001"
|
|
}
|
|
},
|
|
"binary": "8D 00 01000000",
|
|
"notes": "Header: (2<<6)|(3<<2)|1 = 0x8D. Version 2 = V3 (reserved)."
|
|
},
|
|
{
|
|
"id": "ver-003",
|
|
"description": "Version 3 (V4, reserved) - bits 6-7 = 11",
|
|
"type": "encode_decode",
|
|
"structured": {
|
|
"header": {
|
|
"version": 3,
|
|
"payload_type": "ack",
|
|
"route_type": "flood"
|
|
},
|
|
"path": {
|
|
"hash_size": 1,
|
|
"hash_count": 0,
|
|
"hashes": []
|
|
},
|
|
"payload": {
|
|
"ack_crc": "00000001"
|
|
}
|
|
},
|
|
"binary": "CD 00 01000000",
|
|
"notes": "Header: (3<<6)|(3<<2)|1 = 0xCD. Version 3 = V4 (reserved)."
|
|
}
|
|
]
|
|
}
|