Docs audit [April 2026]: Run mdformat on all#3299
Draft
C-Achard wants to merge 1 commit intocy/docs-audit-april-2026-docs-updatefrom
Draft
Docs audit [April 2026]: Run mdformat on all#3299C-Achard wants to merge 1 commit intocy/docs-audit-april-2026-docs-updatefrom
C-Achard wants to merge 1 commit intocy/docs-audit-april-2026-docs-updatefrom
Conversation
C-Achard
added
enhancement
This was referenced Apr 28, 2026
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.
Motivation
This PR is part of a broader documentation auditing process, which aims to offer a clean, systematic review of current documentation, suggest potential improvements, and start updating critical pages.
See:
Suggested merge order:
Scope
Runs the newly added mdformat hook on all documentation files.
Note
It is expected that numbered bullet lists all show "1.". Markdown will automatically re-number them on build.