docs: clear pre-existing docs-check failures - #110
Merged
Conversation
Make `npm run docs:check` pass cleanly: - Add a language to 13 unlabelled code fences (http for S3 request lines, bash for commands, text for output/URLs/trees) - Replace banned example values: mc.md endpoint 12.34.56.78 -> 192.168.1.100 with placeholder keys; mcp.md region cn-east-1 -> us-east-1 - Delete two vestigial concept index pages (concepts/index.md and concepts/principle/index.md) that duplicated the sidebar and, in the case of principle/index, listed unlinked placeholder bullets - docs-check: resolve a .md link when only the sibling .mdx exists (and vice versa), matching how FumaPress maps links by URL — fixes the three docker/index.mdx link reports docs-check now passes; build OK (295 pages).
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
docs-rustfs-com | 0414be9 | Commit Preview URL Branch Preview URL |
Jul 16 2026, 06:00 AM |
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
Clears every finding the
docs:checkGitHub Action reports onmain, so the workflow goes green. Each was pre-existing and unrelated to any single feature PR.Code fences without a language (13) — added a language to each:
httpfor S3 request lines (PUT /{bucketName} HTTP/1.1, …),bashfor thedocker composecommand,textfor command output, URLs, and the directory tree.Banned example values (2)
developer/mc.md— endpoint12.34.56.78→192.168.1.100with<your-access-key>/<your-secret-key>placeholdersdeveloper/mcp.md— regioncn-east-1→us-east-1Orphan pages (2) — deleted two vestigial concept index pages that duplicated the sidebar:
concepts/index.md(a hand-maintained TOC) andconcepts/principle/index.md(which listed unlinked placeholder bullets — "Stripes / Data Scanner / Data Self-healing / Stripes", the "画饼目录" flagged in the review). The real child,erasure-coding, is linked directly in the sidebar and is untouched.Broken
.mdlinks (3) — the three./docker/index.mdreports came from the earlier VitePress→FumaPress rename (docker/index.md→.mdx). FumaPress resolves links by URL, not on-disk extension, so a.mdlink to a page that now ships as.mdxrenders fine. Updatedscripts/docs-check.mjsto accept a.mdlink when only the sibling.mdxexists (and vice versa) rather than rewriting the documented.mdlink convention.Result
npm run build✓ (295 pages). Independent of #109 — no overlapping files.