📖 [Docs]: Specification anchors now pass Markdown linting - #159
Closed
Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
Closed
📖 [Docs]: Specification anchors now pass Markdown linting#159Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
Conversation
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>
Member
Author
|
Superseded by #144, which delivered this change with the accompanying Markdown standard update. |
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
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.
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
{#id}; the link validator's help now demonstrates the same form.src/docs/Ways-of-Working/Spec-Driven-Development.mdsrc/docs/Capabilities/**/spec.md.github/scripts/Test-DocumentationLink.ps1.github/linters/.markdown-lint.ymlRelevant issues (or links)