Skip to content

Commit c93de7c

Browse files
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/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,17 +95,17 @@ Three entry modes determine how Phase 1 begins. All converge at Phase 2 once AI
9595
| `from-prd` | PRD/BRD documents | Projects with product definition artifacts |
9696
| `from-security-plan` | Security plan state | Projects that completed security planning first (recommended) |
9797

98-
See [entry modes](entry-modes) for detailed guidance on when to choose each mode and what each mode pre-populates.
98+
See [entry modes](entry-modes.md) for detailed guidance on when to choose each mode and what each mode pre-populates.
9999

100100
## Related Pages
101101

102102
| Page | Description |
103103
|--------------------------------------------|------------------------------------------------------------------------|
104-
| [Why RAI planning?](why-rai-planning) | The case for structured RAI assessment over ad-hoc reviews |
105-
| [Agent overview](agent-overview) | Architecture, state management, and interaction model |
106-
| [Entry modes](entry-modes) | Choosing between capture, from-prd, and from-security-plan |
107-
| [Phase reference](phase-reference) | Detailed inputs, outputs, and state transitions for all six phases |
108-
| [Handoff pipeline](handoff-pipeline) | Scorecard generation, backlog output, and the Security-to-RAI pipeline |
104+
| [Why RAI planning?](why-rai-planning.md) | The case for structured RAI assessment over ad-hoc reviews |
105+
| [Agent overview](agent-overview.md) | Architecture, state management, and interaction model |
106+
| [Entry modes](entry-modes.md) | Choosing between capture, from-prd, and from-security-plan |
107+
| [Phase reference](phase-reference.md) | Detailed inputs, outputs, and state transitions for all six phases |
108+
| [Handoff pipeline](handoff-pipeline.md) | Scorecard generation, backlog output, and the Security-to-RAI pipeline |
109109
| [Security planning overview](../security/) | The Security Planner agent that feeds into RAI assessment |
110110

111111
<!-- markdownlint-disable MD036 -->

docs/agents/rai-planning/entry-modes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Prompt file: `.github/prompts/rai-planning/rai-plan-from-security-plan.prompt.md
101101

102102
Once Phase 1 completes, all three modes converge into the same workflow for Phases 2 through 6. The entry mode is recorded in `state.json` and cannot change after assessment begins.
103103

104-
See [Phase Reference](phase-reference) for the complete specification of each phase.
104+
See [Phase Reference](phase-reference.md) for the complete specification of each phase.
105105

106106
<!-- markdownlint-disable MD036 -->
107107
*🤖 Crafted with precision by ✨Copilot following brilliant human instruction,

docs/agents/rai-planning/why-rai-planning.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ You do not need RAI expertise to start. The agent guides the assessment conversa
9191
| Time to Phase 2 | Longest: full scoping interview | Medium: confirm and refine extracted scope | Shortest: verify pre-populated data |
9292
| Best for | Exploratory assessments, standalone AI projects | Projects with existing product documentation | The recommended workflow after security planning |
9393

94-
See [Entry Modes](entry-modes) for step-by-step instructions on starting each mode.
94+
See [Entry Modes](entry-modes.md) for step-by-step instructions on starting each mode.
9595

9696
<!-- markdownlint-disable MD036 -->
9797
*🤖 Crafted with precision by ✨Copilot following brilliant human instruction,

docs/agents/security/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The Security Planner agent walks your team through a structured six-phase securi
3232
| ⚡ Actionable output | The final phase produces backlog items with acceptance criteria, autonomy tiers, and direct links to the threats they address |
3333

3434
> [!TIP]
35-
> New to the agent? Read [Why Security Planning?](why-security-planning) for the reasoning behind each phase.
35+
> New to the agent? Read [Why Security Planning?](why-security-planning.md) for the reasoning behind each phase.
3636
3737
## The Security Planning Flow
3838

@@ -130,11 +130,11 @@ The Security Planner supports two entry modes, each matched to a prompt file.
130130

131131
## Next Steps
132132

133-
* [Why Security Planning?](why-security-planning) for the reasoning behind each phase.
134-
* [Agent Overview](agent-overview) for the architecture and state management details.
135-
* [Entry Modes](entry-modes) for a deep dive into From-PRD vs. capture workflows.
136-
* [Phase Reference](phase-reference) for phase-by-phase field and artifact details.
137-
* [Handoff Pipeline](handoff-pipeline) for backlog generation and RAI dispatch.
133+
* [Why Security Planning?](why-security-planning.md) for the reasoning behind each phase.
134+
* [Agent Overview](agent-overview.md) for the architecture and state management details.
135+
* [Entry Modes](entry-modes.md) for a deep dive into From-PRD vs. capture workflows.
136+
* [Phase Reference](phase-reference.md) for phase-by-phase field and artifact details.
137+
* [Handoff Pipeline](handoff-pipeline.md) for backlog generation and RAI dispatch.
138138

139139
<!-- markdownlint-disable MD036 -->
140140
*🤖 Crafted with precision by ✨Copilot following brilliant human instruction,

docs/agents/sssc-planning/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The SSSC Planner agent walks your team through a structured six-phase supply cha
3232
| ⚡ Actionable output | The final phase produces backlog items with adoption steps, priority derived from risk level, and improvement projections per check |
3333

3434
> [!TIP]
35-
> New to the agent? Read [Why SSSC Planning?](why-sssc-planning) for the reasoning behind each phase.
35+
> New to the agent? Read [Why SSSC Planning?](why-sssc-planning.md) for the reasoning behind each phase.
3636
3737
## The SSSC Planning Flow
3838

@@ -133,11 +133,11 @@ The SSSC Planner supports four entry modes, each matched to a prompt file.
133133

134134
## Next Steps
135135

136-
* [Why SSSC Planning?](why-sssc-planning) for the reasoning behind each phase.
137-
* [Agent Overview](agent-overview) for the architecture and state management details.
138-
* [Entry Modes](entry-modes) for a deep dive into all four entry mode workflows.
139-
* [Phase Reference](phase-reference) for phase-by-phase field and artifact details.
140-
* [Handoff Pipeline](handoff-pipeline) for backlog generation and improvement projections.
136+
* [Why SSSC Planning?](why-sssc-planning.md) for the reasoning behind each phase.
137+
* [Agent Overview](agent-overview.md) for the architecture and state management details.
138+
* [Entry Modes](entry-modes.md) for a deep dive into all four entry mode workflows.
139+
* [Phase Reference](phase-reference.md) for phase-by-phase field and artifact details.
140+
* [Handoff Pipeline](handoff-pipeline.md) for backlog generation and improvement projections.
141141

142142
<!-- markdownlint-disable MD036 -->
143143
*🤖 Crafted with precision by ✨Copilot following brilliant human instruction,

0 commit comments

Comments
 (0)