Add DocC documentation sync gate#478
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a DocC synchronization gate so mirrored hosted documentation and repository Markdown stay aligned on required operational anchors.
Changes:
- Adds an anchor-based DocC sync contract and validation script.
- Adds
make docc-syncplus focused pytest coverage. - Documents the mandatory sync workflow in contributor and agent guidance.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
tools/validate_docc_sync.py |
Implements contract loading and anchor validation. |
tools/docc_sync_contract.json |
Defines synchronized doc/DocC groups and required anchors. |
tests/test_docc_sync.py |
Verifies the checked-in sync contract passes. |
Makefile |
Adds the docc-sync shortcut and help entry. |
CONTRIBUTING.md |
Documents the DocC sync rule for contributors. |
AGENTS.md |
Adds the sync rule to agent operating guidance. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2fa36853fd
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Summary
tools/validate_docc_sync.pyandmake docc-syncto validate required anchors across ordinary docs and DocC pages.AGENTS.mdandCONTRIBUTING.md.Motivation
Sources/SpecGraph/Documentation.docc/pages from drifting when operational guidance changes.Goals
Changes
tools/docc_sync_contract.jsonwith synchronization groups and required anchors.tools/validate_docc_sync.py.tests/test_docc_sync.py.make docc-syncand listed it in Makefile help.AGENTS.mdandCONTRIBUTING.mdwith the DocC synchronization rule.Validation
Commands run:
make docc-sync python3 -m pytest -q tests/test_docc_sync.py # pre-commit hooks during commit: python-quality spec-yaml-format spec-yaml-lint ruff (legacy alias) ruff formatResults:
make docc-sync: passedpython3 -m pytest -q tests/test_docc_sync.py: 1 passedRisks / Notes
tools/docc_sync_contract.jsonwhen they become mirrored DocC surfaces.Checklist