docs: add docs quality tooling follow-up#61
Draft
snissn wants to merge 10 commits into
Draft
Conversation
✅ Deploy Preview for timely-kataifi-9f3a09 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
4 tasks
…on-save - Merge .markdownlint.json into .markdownlint-cli2.jsonc so the CLI, CI, and the VS Code extension all read a single source of truth. - Disable MD013 (line-length), MD029 (ordered-list prefix), and MD036 (emphasis-as-heading); relax MD024 to siblings_only, pin MD004 to asterisk style, and add an explicit MD033 allow-list covering the HTML elements used by GitBook custom blocks. - Ignore _book/, node_modules/, .claude/, .cursor/, .zed/, .agents/, .gitbook/, and reference/json-rpc/. - Add .vscode/settings.json with format-on-save plus source.fixAll.markdownlint for markdown files, trailing-whitespace trim, and final-newline insertion. - Add .vscode/extensions.json recommending DavidAnson.vscode-markdownlint.
- Run npm run lint:fix across the docs tree to normalize list markers (MD004), consecutive blank lines (MD012), heading spacing (MD022), list-marker spacing (MD030), code-fence padding (MD031), list padding (MD032), bare URLs (MD034), trailing newlines (MD047), emphasis style (MD049), and trailing whitespace / hard tabs (MD009, MD010). - Add language tags to remaining fenced code blocks (MD040), alt text to figures and badges (MD045), and correct heading-level skips across community, cookbook, storage-providers, and core- concepts pages (MD001, MD041, MD025), cascading sibling demotions where needed to keep hierarchy valid. - Tighten a handful of lists and code fences missed by the autofixer (MD032, MD031). Repo now lints clean end-to-end.
Member
|
@copilot resolve the merge conflicts in this pull request |
Resolved in |
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.
Summary
This adds the local docs-quality tooling on top of the IA refresh branch.
It introduces the checker toolchain, wires the local scripts and config, and adds the docs-quality CI workflow.
How to review
feat(docs): add checker toolchainAdds the shared checker implementation under
scripts/checkers/.chore(docs): wire local docs quality scripts and configAdds the package scripts, markdown lint config, link-ignore config, and supporting repo wiring.
ci(docs): add docs quality workflowAdds the GitHub Actions workflow for docs-quality checks.
Validation
npm run buildnpm run check-links