Add DOX validation, templates, and evidence docs#1
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR formalizes an optional, machine-checkable DOX (AGENTS.md) tree convention by adding a structural linter, wiring it into CI, and documenting the convention, templates, and evidence guidance so repositories can keep DOX contracts and child indexes consistent over time.
Changes:
- Add a no-dependency DOX structural validator (
scripts/dox_lint.py) and run it in GitHub Actions on PRs and pushes tomain. - Introduce and index new DOX subtrees (
.github/,agents/,docs/,scripts/) with correspondingAGENTS.mdcontracts. - Expand documentation with usage examples, a formal convention spec, and evidence/caveat notes.
Reviewed changes
Copilot reviewed 12 out of 13 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
scripts/dox_lint.py |
New structural validator for DOX trees (root markers, required sections, child-index link resolution). |
scripts/AGENTS.md |
Defines local contracts and verification expectations for scripts in this repo. |
README.md |
Adds usage examples, optional validation instructions, and links to spec/evidence docs. |
docs/spec.md |
Documents the optional machine-checkable DOX convention and validator behavior. |
docs/evidence.md |
Records reported external observations plus caveats to avoid overclaiming impact. |
docs/AGENTS.md |
Establishes ownership/contracts for DOX specifications and evidence docs. |
agents/orchestrator.md |
Adds a portable orchestrator agent template for coordinating DOX maintenance. |
agents/documenter.md |
Adds a focused documenter agent template for updating the nearest owning AGENTS.md. |
agents/AGENTS.md |
Defines ownership/contracts for the agent template subtree. |
AGENTS.md |
Adds protected core markers and initializes the root Child DOX Index and project-level guidance. |
.gitignore |
Introduces standard ignores for Python caches/venvs and common build artifacts. |
.github/workflows/dox-lint.yml |
Adds CI job to run the structural validator. |
.github/AGENTS.md |
Defines ownership/contracts for GitHub automation and the DOX lint workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+86
to
+93
| start = root_text.find(CORE_START) | ||
| end = root_text.find(CORE_END) | ||
| if start == -1: | ||
| errors.append("root AGENTS.md missing DOX-CORE-START marker") | ||
| if end == -1: | ||
| errors.append("root AGENTS.md missing DOX-CORE-END marker") | ||
| if start != -1 and end != -1 and start > end: | ||
| errors.append("root AGENTS.md DOX core markers are out of order") |
Comment on lines
+108
to
+113
| for line in child_index_body(text): | ||
| match = CHILD_ENTRY_RE.match(line) | ||
| if not match: | ||
| continue | ||
| child_rel = match.group(1) | ||
| child_path = (agents_path.parent / child_rel).resolve() |
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
This PR turns the fork into a consolidated five-resolution version of DOX:
scripts/dox_lint.pystructural validatorMaps to upstream issues / PRs
Verification
Ran locally:
python3 scripts/dox_lint.py . python3 -m py_compile scripts/dox_lint.py git diff --checkResult: passed.