Repository navigation
docs: add folder-level README and AGENTS guides - #7
Merged
Merged
Conversation
Cover 22 undocumented authoring directories: CI configuration, the pinned GNN specification, and the src layers (kernels, provenance, artifacts, curriculum plus catalog_data and materials, scholarship, manuscript, figures plus plots, dashboard plus assets, skilltree, pipeline, integration, validation, pilot, publication, screenshots). Add 44 files: 22 README guides and 22 AGENTS guides. Generated output/, .omo evidence, generated docs/todo roadmap pages, captured manuscript screenshots and the vendored SkillTree client are skip-listed with reasons. Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
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.
Adds
README.mdandAGENTS.mdto the authoring directories that lacked them.Coverage
Measured at
origin/main10a7dde: 54 directory paths, 547 tracked files. Before: 8 had both guides, 1 had a README only, 45 had neither. This change adds 44 files across 22 directories. After: 30 have both, 1 has a README only, 23 have neither and each is listed below.New guides:
.github,.github/workflows,gnnsrc/kernels,src/provenance,src/artifacts,src/validationsrc/curriculum,src/curriculum/catalog_data,src/curriculum/materialssrc/scholarship,src/manuscriptsrc/figures,src/figures/plotssrc/dashboard,src/dashboard/assets,src/skilltreesrc/pipeline,src/integration,src/pilot,src/publication,src/screenshotsSkips with reasons
output/**(11 paths): regenerated artifacts and reviewer surfaces;docs/output_conventions.mdowns the layout..omo/**(7): retained agent-run evidence; not an authoring surface.docs/todo: generated fromtasks.yaml.tests/test_docs_inventory.pyrequires the directory's files to match the active task IDs exactly, so adding a README or AGENTS file there would fail the gate.manuscript/assetsandmanuscript/assets/screenshots: captured dashboard evidence at exact paths registered insrc/figures/registry.pyandsrc/dashboard/artifact_catalog.py;scripts/capture_dashboard_screenshots.pyrewrites it.manuscript/sheaf: manuscript evidence constants consumed from the manuscript tree;manuscript/AGENTS.mdowns the editing rules.src/dashboard/assets/vendor: vendored third-party SkillTree client.docs/pilot: has a section README;docs/AGENTS.mdowns the subtree andsrc/pilot/AGENTS.mdowns contract edits.Verification
uv run --no-sync pytest tests/test_docs_inventory.py -q: 7 passed.git diff --cached --check: clean.CI runs the offline gates (lint, mypy, curriculum and artifact builds, provenance/scholarship/manuscript validators, 90% coverage) and the pinned GNN conformance job.