docs: link orphaned docs (CHANGELOG, AGENTS, PRIOR_ART, etc.) from README/llms.txt - #3
Merged
Merged
Conversation
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
Per AGENTS.md's docs-honesty rule ("if you create a new markdown file, link it from somewhere real ... an unlinked doc is a dead end"), these existing docs were reachable transitively but not directly linked from README.md's doc table or llms.txt. This is a completeness fix, not an urgent bug — all seven docs were already reachable from some other doc.
Additive-only changes — no existing row/line in either file was reordered, restructured, or rewritten.
README.md (
## Documentationtable)docs/CONTEXT.md(short pointer to VISION.md) anddocs/preview/sample-report.md(example report output)CHANGELOG.md,docs/PRIOR_ART.md,docs/ANNOUNCE.mddocs/TRIAL_PROTOCOL.md(methodology behind TRIAL_RESULTS.md)AGENTS.md(alongside CLAUDE.md, which is just@AGENTS.md)llms.txt
docs/CONTEXT.mddocs/preview/sample-report.mddocs/TRIAL_PROTOCOL.mdCHANGELOG.md,docs/PRIOR_ART.md,docs/ANNOUNCE.md, and noted thatCLAUDE.mdis an alias pointing atAGENTS.mdNote on docs/CONTEXT.md
Per D53 in DECISIONS.md,
docs/CONTEXT.mdis intentionally kept as a short live redirect stub todocs/VISION.md— it's linked in both files as exactly that (a pointer), not "fixed" into something else.Verification
ruff check .— passedpython -m py_compileon all tracked.pyfiles — passedbash scripts/check_app_js.sh && node scripts/fe_test.js— passed (expected no-op for a markdown-only change)pytest tests/ -q— this VPS was under heavy concurrent CPU load (ollama + other sessions) during this change, making the full suite very slow to complete. A partial run against a shared venv got through ~25/540 tests across 19 test files with zero failures/errors before the PR was opened (this diff touches no Python code, so no test outcome is expected to change).🤖 Generated with Claude Code