Skip to content

Explain selected Start examples and include them in the sitemap - #1262

Open
tannerlinsley wants to merge 1 commit into
mainfrom
taren/start-example-landing-pages
Open

tannerlinsley wants to merge 1 commit into
mainfrom
taren/start-example-landing-pages

Conversation

@tannerlinsley

@tannerlinsley tannerlinsley commented Sep 11, 2026

Copy link
Copy Markdown
Member

Explain three existing Start React examples before adding them to the sitemap: basic routing, React Query, and static rendering. Each page now has a specific title and description, server-rendered setup instructions, key source-file links, and a related guide. The static example explains its sample base path, sitemap host, and build-time data behavior.

The same curated selection controls page content and sitemap inclusion. Other examples stay excluded from the sitemap, and old-version canonical behavior is unchanged.

Validation: full site checks passed (515 tests, 3 skips, types and lint); all three example build commands passed; headless checks verified each page without JavaScript, canonical URLs, guide links, and actual sitemap inclusion/exclusion. Desktop and mobile layouts were inspected. Sidebar and fullscreen controls passed after the local development client settled. Immediate-click diagnostics caught inert server HTML during preview startup; no production timing guarantee is claimed.

Summary by CodeRabbit

  • New Features
    • Added Start example pages for basic, React Query, and static applications.
    • Added setup details, run instructions, source file links, and related guide links to each example.
    • Added page-specific titles and descriptions for improved sharing and discoverability.
    • Added the new example pages to the sitemap.

@coderabbitai

coderabbitai Bot commented Sep 12, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: c61486b4-c01e-4ad9-a65a-7befd318ac35

📥 Commits

Reviewing files that changed from the base of the PR and between 1566dd6 and 9e982e7.

📒 Files selected for processing (4)
  • src/components/StartExampleOverview.tsx
  • src/routes/_library/$libraryId/$version.docs.framework.$framework.examples.$.tsx
  • src/utils/sitemap.ts
  • src/utils/start-example-pages.ts

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

The change adds three TanStack Start example pages. It defines their metadata, renders overview content and page metadata, and includes their URLs in the sitemap.

Changes

Start example pages

Layer / File(s) Summary
Example metadata and lookup
src/utils/start-example-pages.ts
Defines three TanStack Start examples and resolves them for the latest React Start routes.
Example route rendering
src/components/StartExampleOverview.tsx, src/routes/_library/.../examples.$.tsx
Renders descriptions, instructions, file links, guides, titles, and Open Graph metadata for matching examples.
Example sitemap integration
src/utils/sitemap.ts, src/utils/start-example-pages.ts
Adds the three start example URLs to the generated sitemap.

Priority: ⬇️ Low

Estimated code review effort: 3 (Moderate) | ~25 minutes

Change: Feature

Sequence Diagram(s)

sequenceDiagram
  participant ExampleRoute
  participant getStartExamplePage
  participant StartExampleOverview
  ExampleRoute->>getStartExamplePage: resolve route params
  getStartExamplePage-->>ExampleRoute: return matching metadata or undefined
  ExampleRoute->>StartExampleOverview: pass route params
  StartExampleOverview->>getStartExamplePage: resolve example metadata
  getStartExamplePage-->>StartExampleOverview: return page content
  StartExampleOverview-->>ExampleRoute: render overview or null
Loading

Merge Risk: ⚪ Minimal · up to 9e982

The three example pages, their rendered metadata, and sitemap entries are aligned with the stated scope and validation results. No merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 6 functions across 4 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main changes: adding explanations for selected Start examples and including those pages in the sitemap.
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.
  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch taren/start-example-landing-pages

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

Comment @coderabbitai help to get the list of available commands.

@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 9e982e7 Commit Preview URL

Branch Preview URL
Sep 12 2026, 12:00 AM

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