Repository navigation
fix(seo): exclude documentation artifacts from the sitemap - #1470
Conversation
|
|
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Add and test the shared slug predicate src/utils/sitemap-docs.ts, tests/sitemap-docs.test.ts |
isHighValueDocsSlug excludes empty slugs, specified path segments, and exact low-value slugs. Tests cover excluded and retained examples. |
Use the shared predicate in the sitemap src/utils/sitemap.ts |
The sitemap imports isHighValueDocsSlug and removes its local filter implementation and low-value sets. |
Estimated code review effort: 2 (Simple) | ~10 minutes
Change: Bug fix
Suggested reviewers: ladybluenotes
Merge Risk: 
adab8
-
The change excludes documentation artifacts from the sitemap. No merge-blocking risk is established.
Pre-merge checks: 
-
Check name Status Explanation Resolution Docstring Coverage Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… Write docstrings for the functions missing them to satisfy the coverage threshold. -
Check name Status Explanation Description Check Check skipped - CodeRabbit’s high-level summary is enabled. Title check The title clearly and concisely describes the main change: excluding documentation artifacts from the sitemap. Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage
-
Explanation
Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 1 functions across 3 files.
Resolution
Write docstrings for the functions missing them to satisfy the coverage threshold.
-
Finishing Touches
-
Generate docstrings
-
- Commit to this branch
- Create a new PR
Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
tanstack-com | adab863 | Commit Preview URL Branch Preview URL |
Nov 01 2026, 04:53 AM |
The live sitemap includes documentation drafts and repository README files. Filter
draftsdirectories,.draftpaths and README segments before generating documentation entries, preserving the existing exclusions and public guide paths.The path filter is separated from the server-backed sitemap module so its behavior can be tested without loading image assets and server imports. A fresh production sitemap contained ten matching artifacts. The regression failed against the previous filter and passes with the fix, including nested paths and retained public guides.
This addresses the repository-artifact portion of #1153. That issue remains open for redirect resolution, unhealthy generated reference pages, showcase coverage and the full deployed-page contract. The independent Charts canonical URL fix is #1469 and source-failure handling is #1267.
Validation: focused regression tests pass. Normal commit hooks passed formatting, TypeScript, lint, 687 unit tests, 2,278 chat tests and 20 desktop tests, with 5, 6 and 1 skipped respectively. Offline evaluation against the captured production sitemap removes the ten reported artifacts; this is not a deployed result.
Summary by CodeRabbit