docs(concepts): schema-format.md + meta-schema.md (#127)#200
Merged
Conversation
Closes #127. Graduates the internal `.agents/context/schema-spec.md` design brief into public, maintained user-facing documentation. Two new docs: - `docs/concepts/schema-format.md` — canonical reference for the decree.schema.yaml format. Every top-level key, every field option, every constraint with the per-type compatibility matrix, the dependentRequired and validations cross-field rule mechanisms, the field-path and slug regexes, recommended `format:` values (advisory list), import/export semantics, strict mode. - `docs/concepts/meta-schema.md` — what the JSON Schema 2020-12 meta-schemas under `schemas/v0.1.0/` cover (layer 1) vs non-goals (layer 2 semantic rules stay Go-side). URL scheme + SemVer + stability policy. How to wire the meta-schema into editor tooling (yaml-language-server modeline) and CI (check-jsonschema, ajv, santhosh-tekuri/jsonschema). Trims `docs/concepts/schemas-and-fields.md` to be the higher-level concepts overview — lifecycle, drafts vs published versions, quick example, brief intros to types and cross-field rules — and cross-links out to schema-format.md and meta-schema.md for full reference details. Updates `docs/getting-started.md` to use the canonical `decree.schema.yaml` filename and the `# yaml-language-server: $schema=...` modeline. Updates README.md to link the new format reference and the published meta-schema URLs. Adds the new docs to mkdocs.yml nav. Fixes the now-orphaned anchor link from typed-values.md to point at schema-format.md#constraints. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Thanks for your first pull request! We appreciate the contribution. Before review, please make sure:
|
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.
Closes #127.
Summary
Graduates the internal `.agents/context/schema-spec.md` design brief into public, maintained user-facing documentation. Two new docs under `docs/concepts/`:
`schema-format.md` — canonical reference for the `decree.schema.yaml` format. Every top-level key, every field-level option, every constraint with the per-type compatibility matrix, the `dependentRequired` and `validations` cross-field rule mechanisms, the field-path and slug regexes, recommended `format:` values (advisory list), import/export semantics, strict mode, vendor extensions.
`meta-schema.md` — what the JSON Schema 2020-12 meta-schemas under `schemas/v0.1.0/` cover (layer 1) vs non-goals (layer 2 semantic rules stay Go-side). URL scheme + SemVer + stability policy. How to wire the meta-schema into editor tooling (yaml-language-server modeline) and CI / programmatic validators (check-jsonschema, ajv, santhosh-tekuri/jsonschema).
Reorganization
`schemas-and-fields.md` is trimmed to be the higher-level concepts overview — lifecycle, drafts vs published versions, quick example, brief intros to types and cross-field rules — and cross-links out to `schema-format.md` (full reference) and `meta-schema.md` (mechanical validation). The full format reference content moved to `schema-format.md`.
Other updates
Test plan
Out of scope (follow-ups)