docs: fix broken intra-repo links in docs/ (ag-28dp #docs-link-rot)#781
Merged
Conversation
44 broken intra-repo links across 7 docs surfaced by a docs/ link audit (mkdocs strict:false, so no gate caught them — but they break GitHub-raw viewing and agent file-reading). Two pointer-rot classes: - 41x ](skills/<name>.md) -> ](../skills/<name>/SKILL.md): skills live at skills/<name>/SKILL.md, never skills/<name>.md. Several links already had the correct LINK TEXT (e.g. [skills/pre-mortem/SKILL.md](skills/pre-mortem.md)), confirming intent. Special case skills/catalog.md -> SKILLS.md (the 82-skill reference). - 3x ](cli/commands.md) -> ](../cli/docs/COMMANDS.md). Excludes the intentional placeholder links in docs/standards/markdown-style-guide.md (syntax demos: url, image.png, etc.). Re-running the docs/ broken-link scan: 44 -> 0 outside placeholders. markdownlint-cli2: 0 errors. Closes-scenario: ag-28dp#docs-link-rot Bounded-context: BC1-Corpus Evidence: ag-28dp
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.
What
Fix 44 broken intra-repo links across 7 files under
docs/, surfaced by adocs/markdown link audit.mkdocs.ymlhasstrict: false, so the broken links slipped past CI — but they break GitHub-raw viewing and agent file-reading (the repo treats pointer rot in base docs as a defect).Two pointer-rot classes
](skills/<name>.md)→](../skills/<name>/SKILL.md)— skills live atskills/<name>/SKILL.md, neverskills/<name>.md, anddocs/is one level deep so the target needs../. Several links already had the correct link text (e.g.[skills/pre-mortem/SKILL.md](skills/pre-mortem.md)) — only the href was wrong, confirming intent. Special case:skills/catalog.md→SKILLS.md(docs/SKILLS.md= the complete 82-skill reference).](cli/commands.md)→](../cli/docs/COMMANDS.md)— the generated CLI command doc.Files:
GLOSSARY.md,index.md,context-lifecycle.md,behavioral-discipline.md,create-your-first-skill.md,context-packet.md,software-factory.md.Not touched: the intentional placeholder links in
docs/standards/markdown-style-guide.md(syntax demos:url,image.png,./other-doc.md, etc.).Verification
docs/broken-link scan: 44 → 0 outside the style-guide placeholders.markdownlint-cli2on all 7 files: 0 errors.Closes-scenario: ag-28dp#docs-link-rot
Bounded-context: BC1-Corpus
Evidence: ag-28dp