Commit c93de7c
authored
fix(docs): add missing .md extensions to relative links in agent documentation (#1180)
Relative markdown links in the *rai-planning*, *security*, and
*sssc-planning* agent documentation directories used bare file names
without `.md` extensions (e.g., `(entry-modes)` instead of
`(entry-modes.md)`). This caused link validation failures and broken
navigation in rendered documentation. All 20 affected links now include
the `.md` suffix; every target file was verified to exist on disk.
## Description
The three agent documentation sets — **rai-planning**, **security**, and
**sssc-planning** — shared an identical extensionless link pattern,
likely inherited from a common template. Each README contained a tip
callout or inline reference with one broken link plus a Related Pages /
Next Steps section with five broken sibling-page links. Two additional
files in *rai-planning* had one broken link each.
- Added `.md` extensions to 6 relative links in
*docs/agents/rai-planning/README.md* — 1 inline reference and 5
table-row links in the Related Pages section
- Added `.md` extensions to 6 relative links in
*docs/agents/security/README.md* — 1 in a TIP callout and 5 in the Next
Steps list
- Added `.md` extensions to 6 relative links in
*docs/agents/sssc-planning/README.md* — 1 in a TIP callout and 5 in the
Next Steps list
- Added `.md` extension to 1 relative link in
*docs/agents/rai-planning/entry-modes.md* targeting *phase-reference.md*
- Added `.md` extension to 1 relative link in
*docs/agents/rai-planning/why-rai-planning.md* targeting
*entry-modes.md*
All corrected targets — *agent-overview.md*, *entry-modes.md*,
*handoff-pipeline.md*, *phase-reference.md*, *why-rai-planning.md*,
*why-security-planning.md*, and *why-sssc-planning.md* — were verified
to exist in their respective directories. The unchanged directory link
`(../security/)` in *rai-planning/README.md* correctly refers to a
folder and was not broken.
## Related Issue(s)
None
## Type of Change
Select all that apply:
**Code & Documentation:**
* [ ] Bug fix (non-breaking change fixing an issue)
* [ ] New feature (non-breaking change adding functionality)
* [ ] Breaking change (fix or feature causing existing functionality to
change)
* [x] Documentation update
**Infrastructure & Configuration:**
* [ ] GitHub Actions workflow
* [ ] Linting configuration (markdown, PowerShell, etc.)
* [ ] Security configuration
* [ ] DevContainer configuration
* [ ] Dependency update
**AI Artifacts:**
* [ ] Reviewed contribution with `prompt-builder` agent and addressed
all feedback
* [ ] Copilot instructions (`.github/instructions/*.instructions.md`)
* [ ] Copilot prompt (`.github/prompts/*.prompt.md`)
* [ ] Copilot agent (`.github/agents/*.agent.md`)
* [ ] Copilot skill (`.github/skills/*/SKILL.md`)
**Other:**
* [ ] Script/automation (`.ps1`, `.sh`, `.py`)
* [ ] Other (please describe):
## Testing
Ran `npm run lint:md-links` after applying all fixes. The link checker
validated 1,803 links across 926 files with **0 broken links** remaining
(previously 20 failures across these 5 files).
## Checklist
### Required Checks
* [x] Documentation is updated (if applicable)
* [x] Files follow existing naming conventions
* [x] Changes are backwards compatible (if applicable)
* [ ] Tests added for new functionality (if applicable)
### Required Automated Checks
The following validation commands must pass before merging:
* [x] Markdown linting: `npm run lint:md`
* [x] Spell checking: `npm run spell-check`
* [x] Frontmatter validation: `npm run lint:frontmatter`
* [x] Skill structure validation: `npm run validate:skills`
* [x] Link validation: `npm run lint:md-links`
* [x] PowerShell analysis: `npm run lint:ps`1 parent 772628b commit c93de7c
5 files changed
Lines changed: 20 additions & 20 deletions
File tree
- docs/agents
- rai-planning
- security
- sssc-planning
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
95 | 95 | | |
96 | 96 | | |
97 | 97 | | |
98 | | - | |
| 98 | + | |
99 | 99 | | |
100 | 100 | | |
101 | 101 | | |
102 | 102 | | |
103 | 103 | | |
104 | | - | |
105 | | - | |
106 | | - | |
107 | | - | |
108 | | - | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
109 | 109 | | |
110 | 110 | | |
111 | 111 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
101 | 101 | | |
102 | 102 | | |
103 | 103 | | |
104 | | - | |
| 104 | + | |
105 | 105 | | |
106 | 106 | | |
107 | 107 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
91 | 91 | | |
92 | 92 | | |
93 | 93 | | |
94 | | - | |
| 94 | + | |
95 | 95 | | |
96 | 96 | | |
97 | 97 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
35 | | - | |
| 35 | + | |
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
| |||
130 | 130 | | |
131 | 131 | | |
132 | 132 | | |
133 | | - | |
134 | | - | |
135 | | - | |
136 | | - | |
137 | | - | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
138 | 138 | | |
139 | 139 | | |
140 | 140 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
35 | | - | |
| 35 | + | |
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
| |||
133 | 133 | | |
134 | 134 | | |
135 | 135 | | |
136 | | - | |
137 | | - | |
138 | | - | |
139 | | - | |
140 | | - | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
141 | 141 | | |
142 | 142 | | |
143 | 143 | | |
| |||
0 commit comments