Skip to content

📖 [Docs]: Specification anchors now pass Markdown linting - #159

Closed
Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
mainfrom
docs-141-unspaced-requirement-anchors
Closed

📖 [Docs]: Specification anchors now pass Markdown linting#159
Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
mainfrom
docs-141-unspaced-requirement-anchors

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Aug 9, 2026

Copy link
Copy Markdown
Member

Specification requirement anchors now use a form understood by both Python-Markdown and markdownlint, so requirements copied from the template keep their in-page links valid in repositories where MD051 runs.

Fixed: Requirement links reported as broken

Functional and non-functional requirement identifiers now use unspaced anchors. Authors can copy the specification template and link to individual requirements without their Markdown linter reporting valid references as broken.


Technical details
  • Requirement-anchor guidance, the specification template, and the 25 existing capability-specification anchors now use {#id}; the link validator's help now demonstrates the same form.
  • MD051 is re-enabled after the repository-wide anchor sweep, so future broken in-page links are again caught by markdownlint.
  • Implementation plan progress — completed every documentation and verification step in Use unspaced requirement anchors in the specification template #141.
Changed surface Standards checked Framework docs checked Result
src/docs/Ways-of-Working/Spec-Driven-Development.md Markdown Spec-Driven Development Fixed in this PR
src/docs/Capabilities/**/spec.md Markdown Python-Markdown attr_list Fixed in this PR
.github/scripts/Test-DocumentationLink.ps1 PowerShell None (no framework-specific docs) Aligned
.github/linters/.markdown-lint.yml markdownlint MD051 None (no framework-specific docs) Fixed in this PR
Relevant issues (or links)

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@MariusStorhaug

Copy link
Copy Markdown
Member Author

Superseded by #144, which delivered this change with the accompanying Markdown standard update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

NoRelease No release required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use unspaced requirement anchors in the specification template

1 participant