Skip to content

Add DOX validation, templates, and evidence docs#1

Merged
samonjoat merged 2 commits into
mainfrom
dox-resolutions
Jul 3, 2026
Merged

Add DOX validation, templates, and evidence docs#1
samonjoat merged 2 commits into
mainfrom
dox-resolutions

Conversation

@samonjoat

Copy link
Copy Markdown
Owner

Summary

This PR turns the fork into a consolidated five-resolution version of DOX:

  • adds an optional machine-checkable DOX tree convention
  • adds a no-dependency scripts/dox_lint.py structural validator
  • adds GitHub Actions CI for DOX linting
  • protects the root DOX framework block with explicit core markers
  • adds portable orchestrator/documenter agent templates
  • adds responsible evidence notes for the reported +193% session-turn claim
  • expands README usage examples and validation guidance
  • initializes DOX child indexes for the new repository areas

Maps to upstream issues / PRs

Verification

Ran locally:

python3 scripts/dox_lint.py .
python3 -m py_compile scripts/dox_lint.py
git diff --check

Result: passed.

Copilot AI review requested due to automatic review settings July 3, 2026 09:38

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 to main.
  • Introduce and index new DOX subtrees (.github/, agents/, docs/, scripts/) with corresponding AGENTS.md contracts.
  • 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 thread scripts/dox_lint.py Outdated
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 thread scripts/dox_lint.py
Comment thread scripts/dox_lint.py
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()
Comment thread docs/spec.md Outdated
@samonjoat samonjoat merged commit 78425d1 into main Jul 3, 2026
1 check passed
@samonjoat samonjoat deleted the dox-resolutions branch July 3, 2026 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants