Skip to content

docs: link orphaned docs (CHANGELOG, AGENTS, PRIOR_ART, etc.) from README/llms.txt - #3

Merged
wikithoughts merged 1 commit into
mainfrom
docs/link-orphan-docs
Aug 30, 2026
Merged

wikithoughts merged 1 commit into
mainfrom
docs/link-orphan-docs

Conversation

@wikithoughts

Copy link
Copy Markdown
Owner

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 (## Documentation table)

  • Users row: added docs/CONTEXT.md (short pointer to VISION.md) and docs/preview/sample-report.md (example report output)
  • Contributors row: added CHANGELOG.md, docs/PRIOR_ART.md, docs/ANNOUNCE.md
  • Skeptics row: added docs/TRIAL_PROTOCOL.md (methodology behind TRIAL_RESULTS.md)
  • AI assistants row: added AGENTS.md (alongside CLAUDE.md, which is just @AGENTS.md)

llms.txt

  • Start here: added docs/CONTEXT.md
  • Using it: added docs/preview/sample-report.md
  • Before you recommend it: added docs/TRIAL_PROTOCOL.md
  • For contributors: added CHANGELOG.md, docs/PRIOR_ART.md, docs/ANNOUNCE.md, and noted that CLAUDE.md is an alias pointing at AGENTS.md

Note on docs/CONTEXT.md

Per D53 in DECISIONS.md, docs/CONTEXT.md is intentionally kept as a short live redirect stub to docs/VISION.md — it's linked in both files as exactly that (a pointer), not "fixed" into something else.

Verification

  • ruff check . — passed
  • python -m py_compile on all tracked .py files — passed
  • bash 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

@wikithoughts
wikithoughts merged commit aa98646 into main Aug 30, 2026
5 of 9 checks passed
@wikithoughts
wikithoughts deleted the docs/link-orphan-docs branch August 31, 2026 10:38
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.

1 participant