Skip to content

fix(seo): exclude repository contributing notes from sitemap - #1475

Merged
tannerlinsley merged 1 commit into
mainfrom
taren/sitemap-maintenance-docs
Nov 1, 2026
Merged

tannerlinsley merged 1 commit into
mainfrom
taren/sitemap-maintenance-docs

Conversation

@tannerlinsley

@tannerlinsley tannerlinsley commented Nov 1, 2026 •

Copy link
Copy Markdown
Member

Keep repository review and design notes out of the sitemap, while leaving the documents themselves available.

AI review notes:
Add contributing to the existing excluded documentation segments. A fresh production sitemap contains 252 matching paths, all under DB. Representative source files are internal review candidates and frozen design specifications. This follows #1153's requirement to exclude repository-maintenance documents.

The regression fails against the prior filter and passes with the change. An offline comparison using the actual old and new filters removes exactly those 252 entries. The three separately curated Start examples are outside this filter and remain unchanged. Preview XML verification is still pending, and #1153 remains open for its other requirements.

Normal commit hooks passed formatting, TypeScript, lint, 690 unit tests, 2,278 chat tests and 20 desktop tests, with 5, 6 and 1 skipped respectively.

Summary by CodeRabbit

  • Bug Fixes
    • The sitemap now excludes pages in the contributing section, including oracle review, design, and maintainer note pages. This keeps those pages from appearing among the sitemap’s high-value documentation entries.

@changeset-bot

changeset-bot Bot commented Nov 1, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: b1bb912

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Nov 1, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 3b8ee6fd-8cd0-42dc-af7d-2988496e67de
Commits

Reviewing files that changed from the base of the PR and between f8be395 and b1bb912.

Files selected for processing: 2
  • src/utils/sitemap-docs.ts
  • tests/sitemap-docs.test.ts

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 0 remain after this review.

Walkthrough

The sitemap filter now classifies contributing as a low-value segment. The exclusion test adds four slugs under that segment.

Changes: Sitemap filtering

Layer / File(s) Summary
Add contributing segment to sitemap exclusion
src/utils/sitemap-docs.ts, tests/sitemap-docs.test.ts
The low-value segment list includes contributing. The test checks four contributing slugs and expects isHighValueDocsSlug to return false for each.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Bug fix

Possibly related issues

  • Issue 1153 requires repository-maintenance documents to be absent from the sitemap. This change excludes paths containing contributing, addressing that specific requirement.

Possibly related PRs

Merge Risk: Minimal · up to b1bb9

No actionable merge-blocking risk is identified.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: excluding repository contributing notes from the sitemap for SEO.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. 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 0 functions across 2 files.

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.

Share

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
tanstack-com b1bb912 Commit Preview URL

Branch Preview URL
Nov 01 2026, 05:51 AM

@tannerlinsley

Copy link
Copy Markdown
Member Author

The deployed preview removes the repository contributing notes and keeps the public example pages.

AI review notes: Checked the actual sitemap XML for b1bb912 at the commit preview. It contains 7,026 entries and no contributing paths. All three curated Start examples and 190 Charts catalog entries remain. Comparing the old and new filters against the captured production sitemap removes exactly 252 DB contributing entries.

@tannerlinsley
tannerlinsley merged commit cac1afb into main Nov 1, 2026
8 checks passed
@tannerlinsley
tannerlinsley deleted the taren/sitemap-maintenance-docs branch November 1, 2026 05:59
@tannerlinsley

Copy link
Copy Markdown
Member Author

This is live now. The sitemap no longer lists the internal contributing notes.

AI review notes: Merge cac1afb has a successful Workers deployment. The fresh production sitemap has 7,026 entries, zero contributing paths, all three curated Start examples, and 190 Charts catalog entries. The broader sitemap work remains open in #1153.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant