fix(docs): eliminate broken-link build warnings - #7
Conversation
- Filter nav helpers to products with generated docs (drops broken /docs/block-mcp/ and /docs/gravitysearch/ links rendered on every page). - Render @SInCE as plain text in the API and hooks generators; per-version since/<version>/ index pages are never generated, so the links 404'd.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThree files are updated to prevent broken links. ChangesFix broken links in nav and generated docs
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
An @see-referenced method is frequently not a rendered heading on the target class page (not in its public set), so #method anchors 404. Link to the class page (always exists). Eliminates the residual broken-anchor warnings.
What
Two root causes behind the Docusaurus broken-link warnings (5,988 on a full build):
getProductsByCategory/getFreeProducts/getThirdPartyProducts) linked every configured product, includingblock-mcpandgravitysearch, which have no generated docs. Now filtered toproducts_with_docs(the same existence check already used elsewhere).@sinceversion links (222). Both the API (renderSinceTags) and hooks generators linked@since Xtosince/<version>/pages that are never generated. Now rendered as plain version text.Verified
gravityviewAPI docs: 0../../../since/links (was many). renderSinceTags is the only since-link emitter; no others remain.block-mcp+gravitysearch(35 → 33 product links).node --check;tagsfrontmatter generation unaffected.Residual (tiny, separate)
~4 cross-reference
#anchorwarnings on generated API class pages remain (e.g.#as_configuration) — a distinct, low-volume issue not addressed here.Independent of the tokens/full-GF PRs; general site fix.
Summary by CodeRabbit
Bug Fixes
@seetag entries now link to the correct owning class page (without method anchors) when class URLs are available.