docs(stories): cross-link audit — fix two paths, add three back-links#68
Merged
Conversation
closes user-stories-crosslink-audit After the recent additions (story 08, runnable demos, install table, worked example) several stories reference each other. Audit walked every Markdown link in docs/user-stories/, README.md, packages/cli/ README.md, packages/mcp/README.md, and the package READMEs and verified each path + anchor against the live tree. Findings: Working: every cross-story link in docs/user-stories/ + README.md resolves to an existing file and a real heading slug. The Auto-detect anchor cross-link added in PR #62 still works; the story 06/07 anchor links in user-stories/README.md still work. Broken paths fixed: packages/mcp/README.md:81 [MIT](../LICENSE) -> ../../LICENSE packages/lint/README.md:102 [MIT](../LICENSE) -> ../../LICENSE Both pointed at packages/LICENSE which doesn't exist; LICENSE lives at the repo root, two dirs up. Inverse / back-links added: Story 02 metadata table now links **ID** + **Blocked by** to Story 04 (the source of truth for blocker ordering) and **Tags** to Story 05 #tag-based-routing (the routing contract). The table footer points at Story 08 for the agent-managed fields (**Blocked**, **Research**, **Last-enriched**, **Parent**) and project-level policies — closing the loop that those fields are defined in detail elsewhere. Story 04 #2 ("Tag preference") was a plain-prose "see Story 05" sentence; now a Markdown hyperlink to Story 05 #tag-based- routing so a reader can jump to the routing contract directly. Verified by a Python anchor-checker that walks every Markdown link in the audited files and asserts: - the path component resolves to an existing file - the anchor matches a heading slug or {#explicit-anchor} in the target Output: "All cross-links resolve cleanly!" on the post-fix tree. Verified: npm run lint, npx -y @tasks-md/lint TASKS.md — 0 errors. --- _🤖 Written by an agent, not Fyodor. Ping me if this looks off._
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
1 participant
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.
Why this is needed
Closes `user-stories-crosslink-audit` (P2 hardening from PR #64).
After the recent additions (story 08, runnable demos, install table, worked example) several stories reference each other and the package READMEs. A drift check was overdue — the `Files Involved` tables and the `See [story N]` cross-links accumulate stale paths every time a story heading changes.
Cross-reference report
A Python anchor-checker walked every Markdown link in `docs/user-stories/`, `README.md`, `packages/cli/README.md`, `packages/mcp/README.md`, `packages/lint/README.md`, and `packages/parser/README.md` and verified each `(path#anchor)` resolves to an existing file + a real heading slug or `{#explicit-anchor}`.
Already correct (no change needed)
Broken paths fixed
`packages/cli/README.md` and `packages/parser/README.md` already had the correct two-up path.
Back-links added
Verification
``` $ python3 anchor_checker.py All cross-links resolve cleanly! ```
Test plan:
🤖 Written by an agent, not Fyodor. Ping me if this looks off.