docs: add repository structure guide (no path renames)#99
Merged
Conversation
Add docs/STRUCTURE.md documenting the canonical repository layout, the deliberate schema/ (unified) vs schemas/ (split) distinction, the public root entry points and historical snapshots kept at root, the preserved SDK package paths, the x.klickd/codename boundary, and a deferred-migration section. Link it from SCHEMA_INDEX.md. Docs-only; no paths moved or renamed.
This was referenced May 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a single authoritative repository-layout document and links it from the schema index. This is a docs-only, additive change — no files were moved or renamed, and no package paths were touched. It is a conservative cleanup that makes the repo easier to navigate and makes future restructuring safe, without risking v4.1 stability.
docs/STRUCTURE.mddocumenting:schema/(unified single-file schemas) andschemas/(split envelope+payload schemas) are intentionally distinct and must not be consolidated — they are referenced by test vectors, release tooling, schema$idURLs, and ~40 doc links.verify_vectors.py/.mjs,load_klickd.py,save_klickd.py) and historical snapshots (SPEC_v30.md,SKILL_v25.md,SKILL_v30.md,klickd_v330_spec.pdf) are kept at root (CI, CONTRIBUTING, issue templates, RFC links depend on them).packages/@klickd/coreandpackages/pypi/klickd(never renamed/moved).x.klickdvs. internal codename boundary for public surfaces.SCHEMA_INDEX.md: one-line pointer to the new structure guide.Why no moves
Investigation showed that consolidating
schema/<->schemas/, relocating root scripts, or moving root historical docs would each break load-bearing references (test vectors,.github/workflows/test-vectors.yml, release/bundle scripts, schema$idURLs, README/CONTRIBUTING/issue-template/RFC links). On a published v4.1 line (npm@klickd/core@4.1.0, PyPIklickd==4.1.0, Zenodo DOI10.5281/zenodo.20459934) those are breaking changes, so they are documented as deferred rather than performed opportunistically.Conflict avoidance
Touches only
docs/STRUCTURE.mdandSCHEMA_INDEX.md. Does not touchREADME.md, so there is no overlap with PR #98.Testing
All run green after the change (docs-only, as expected):
python3 verify_vectors.py-> 77/77 passednode verify_vectors.mjs-> 47/47 passed (13 skipped:hash-wasmnot installed — expected)python3 scripts/validate_v4_schemas.py-> all v4 strict-schema validations passedpython3 -m pytest tests/ -q-> 156 passeddocs/STRUCTURE.mdexists.🤖 Generated by Computer