Skip to content

Surface migration guides in site navigation#144

Merged
justin808 merged 1 commit into
mainfrom
codex/feat/issue-141-migration-guides
Jul 5, 2026
Merged

Surface migration guides in site navigation#144
justin808 merged 1 commit into
mainfrom
codex/feat/issue-141-migration-guides

Conversation

@justin808

Copy link
Copy Markdown
Member

Summary

  • Add route constants for the Inertia, vite-rails, and Next.js migration guides.
  • Surface those guides in the homepage migration card grid.
  • Add the guides to the generated Docusaurus sidebar source so they are reachable from docs navigation.

Why

Issue #141 asks for the migration guides to be discoverable from the docs index and homepage. The guides already exist in synced upstream docs; this PR updates the site-owned navigation surfaces without editing generated docs.

Closes #141

Test plan

  • npm run sync:docs
  • npm run prepare:docs
  • .agents/bin/validate

Codex Decision Log

  • Non-blocking: Whether to edit generated docs index copy.
    • Decision: Do not edit generated docs; expose the existing guide routes from site-owned homepage, route constants, and sidebar source.
    • Why: AGENTS.md says generated docs are rebuilt from upstream and should not be edited directly.
    • Review later: Upstream docs index copy can be handled in react_on_rails if maintainers want a docs-index prose change.

@coderabbitai

coderabbitai Bot commented Jul 4, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@justin808, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 30 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2b3d48a7-027d-4b44-958a-0f6db3b299a6

📥 Commits

Reviewing files that changed from the base of the PR and between e39bb81 and 4733d98.

📒 Files selected for processing (4)
  • prototypes/docusaurus/sidebars.ts
  • prototypes/docusaurus/src/constants/docsRoutes.ts
  • prototypes/docusaurus/src/pages/index.module.css
  • prototypes/docusaurus/src/pages/index.tsx
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/feat/issue-141-migration-guides

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.

@greptile-apps

greptile-apps Bot commented Jul 4, 2026

Copy link
Copy Markdown

Greptile Summary

This PR surfaces more migration guides in the Docusaurus site.

  • Adds route constants for the Inertia Rails, vite_rails, and Next.js migration guides.
  • Adds the three guides to the homepage migration card grid.
  • Adds the guides to the Docusaurus sidebar source.
  • Updates the migration section grid from two columns to three columns.

Confidence Score: 4/5

The sidebar prepare path can drop the new navigation links during build.

  • The homepage route constants and cards follow the existing route pattern.
  • The grid change keeps the existing responsive fallback.
  • The tracked sidebar file is overwritten from upstream during the normal root prepare/build path.

prototypes/docusaurus/sidebars.ts

Important Files Changed

Filename Overview
prototypes/docusaurus/sidebars.ts Adds migration guide entries to the sidebar source, but the standard prepare flow can overwrite this tracked file from upstream.
prototypes/docusaurus/src/constants/docsRoutes.ts Adds route constants for the newly linked migration guides.
prototypes/docusaurus/src/pages/index.tsx Adds three migration guide cards and updates the section heading.
prototypes/docusaurus/src/pages/index.module.css Changes the migration grid to three columns while keeping the existing responsive collapse.

Reviews (1): Last reviewed commit: "Surface migration guides from site navig..." | Re-trigger Greptile

Comment thread prototypes/docusaurus/sidebars.ts
@github-actions

github-actions Bot commented Jul 4, 2026

Copy link
Copy Markdown

Cloudflare preview deployed.

@justin808

Copy link
Copy Markdown
Member Author

Codex closeout evidence for current head 4733d98ce7629c3847122ffef7e6c5135431aff8:

  • Local validation: npm run sync:docs; npm run prepare:docs; .agents/bin/validate passed. Docusaurus emitted the existing broken-link/broken-anchor warnings, but exited 0.
  • Local smoke: built homepage and the three guide pages contain the Inertia Rails, vite_rails, and Next.js migration guide links/titles.
  • Hosted checks: CodeRabbit, Greptile Review, build, and deploy all pass.
  • Hosted preview smoke: https://9b615035.reactonrails-com.pages.dev/ plus /docs/migrating/migrating-from-inertia-rails, /docs/migrating/migrating-from-vite-rails, and /docs/migrating/migrating-from-nextjs all returned OK and contained the expected content.
  • Review threads: Greptile sidebar thread resolved after verifying the current synced upstream sidebar contains the three entries used by the prepare/build path.
  • Merge state: CLEAN; review decision APPROVED.

Final state with merge_authority=ask: ready-no-merge-authority.

@justin808 justin808 merged commit aada2d0 into main Jul 5, 2026
4 checks passed
@justin808 justin808 deleted the codex/feat/issue-141-migration-guides branch July 5, 2026 00:58
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.

Surface Inertia / vite-rails / Next.js migration guides on the docs index and homepage

1 participant