Skip to content

Use canonical docs routes in site shell links#72

Merged
justin808 merged 1 commit intomainfrom
jg/fix-issue-69
Apr 2, 2026
Merged

Use canonical docs routes in site shell links#72
justin808 merged 1 commit intomainfrom
jg/fix-issue-69

Conversation

@justin808
Copy link
Copy Markdown
Member

@justin808 justin808 commented Apr 2, 2026

Summary

  • Add prototypes/docusaurus/src/constants/docsRoutes.ts as a canonical map for site-owned docs paths.
  • Update homepage, examples, and Pro pages to use shared canonical docs routes.
  • Route Pro-oriented CTAs to /docs/pro and /docs/pro/upgrading-to-pro to reduce redirect-dependent navigation.

Testing

  • npm run prepare:docs
  • npm run build

Closes #69

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 2, 2026

Warning

Rate limit exceeded

@justin808 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 18 minutes and 6 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 18 minutes and 6 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ebdf9298-fc53-470f-9b57-56d482f110e7

📥 Commits

Reviewing files that changed from the base of the PR and between 3faacd6 and 7fb37a4.

📒 Files selected for processing (4)
  • prototypes/docusaurus/src/constants/docsRoutes.ts
  • prototypes/docusaurus/src/pages/examples.tsx
  • prototypes/docusaurus/src/pages/index.tsx
  • prototypes/docusaurus/src/pages/pro.tsx
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch jg/fix-issue-69

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 and usage tips.

Copy link
Copy Markdown

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 2 potential issues.

Fix All in Cursor

Bugbot Autofix prepared fixes for both issues found in the latest run.

  • ✅ Fixed: Unused ossVsPro route in docsRoutes constant
    • I removed the unused ossVsPro entry from docsRoutes after confirming it has no references in the repository.
  • ✅ Fixed: Inconsistent trailing slash on docsGuide route only
    • I changed docsGuide from /docs/ to /docs to match the existing route convention and prior behavior.

Create PR

Or push these changes by commenting:

@cursor push 1b560f3c1e
Preview (1b560f3c1e)
diff --git a/prototypes/docusaurus/src/constants/docsRoutes.ts b/prototypes/docusaurus/src/constants/docsRoutes.ts
--- a/prototypes/docusaurus/src/constants/docsRoutes.ts
+++ b/prototypes/docusaurus/src/constants/docsRoutes.ts
@@ -1,8 +1,7 @@
 export const docsRoutes = {
-  docsGuide: '/docs/',
+  docsGuide: '/docs',
   createApp: '/docs/getting-started/create-react-on-rails-app',
   installExistingApp: '/docs/getting-started/installation-into-an-existing-rails-app',
-  ossVsPro: '/docs/getting-started/oss-vs-pro',
   proOverview: '/docs/pro',
   proUpgrade: '/docs/pro/upgrading-to-pro',
   migrateFromReactRails: '/docs/migrating/migrating-from-react-rails',

You can send follow-ups to this agent here.

docsGuide: '/docs/',
createApp: '/docs/getting-started/create-react-on-rails-app',
installExistingApp: '/docs/getting-started/installation-into-an-existing-rails-app',
ossVsPro: '/docs/getting-started/oss-vs-pro',
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unused ossVsPro route in docsRoutes constant

Low Severity

The ossVsPro entry in docsRoutes is defined but never referenced anywhere in the codebase. This PR replaced every former use of the /docs/getting-started/oss-vs-pro path with docsRoutes.proOverview, making ossVsPro dead code from the moment it was introduced.

Fix in Cursor Fix in Web

@@ -0,0 +1,9 @@
export const docsRoutes = {
docsGuide: '/docs/',
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent trailing slash on docsGuide route only

Low Severity

docsGuide is defined as '/docs/' (with trailing slash) while every other route in the map omits the trailing slash. The original hardcoded value was "/docs" without a trailing slash. This inconsistency can cause mismatches with Docusaurus's link-active detection and differs from the convention used in the footer of docusaurus.config.ts, which also uses '/docs' without a trailing slash.

Fix in Cursor Fix in Web

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 2, 2026

Cloudflare preview deployed.

@justin808 justin808 merged commit 927f89c into main Apr 2, 2026
5 checks passed
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.

Docs follow-up: update site shell references for canonical docs routes

1 participant