Skip to content

Curate the examples catalog around maintained demos#102

Open
justin808 wants to merge 4 commits into
mainfrom
jg-codex/examples-catalog
Open

Curate the examples catalog around maintained demos#102
justin808 wants to merge 4 commits into
mainfrom
jg-codex/examples-catalog

Conversation

@justin808
Copy link
Copy Markdown
Member

@justin808 justin808 commented Apr 19, 2026

Summary

  • turn /examples into a curated catalog of current React on Rails starter, migration, and Pro + RSC repos
  • add the public naming taxonomy to the page so repo discovery is clearer
  • point the catalog at the new canonical docs page in react_on_rails

Validation

  • npm --prefix prototypes/docusaurus install
  • REACT_ON_RAILS_REPO=/Users/justin/codex/react_on_rails-wt-docs-batch npm run prepare
  • npm run build

Notes


Note

Low Risk
Primarily documentation-site content/navigation and build-script updates; low risk outside of potential doc build/link regressions if the new page path diverges from upstream.

Overview
Updates the Docusaurus docs navigation to include a new getting-started/examples-and-references page, adds new migration/RSC-related entries to the main sidebar, and exposes the route via docsRoutes.

Reworks /examples from a small list into a curated, sectioned catalog (starters, migrations, Pro RSC demos, legacy) with tags and improved responsive layout/styling, and links it back to the canonical docs page for taxonomy.

Extends the docs preparation tooling to include the new docs page in subset builds: adds it to docsSubsetEntries, updates layout tests, and generates a dedicated subset sidebars.ts when --subset is used.

Reviewed by Cursor Bugbot for commit 9c87441. Bugbot is set up for automated code reviews on this repo. Configure here.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 19, 2026

Warning

Rate limit exceeded

@justin808 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 30 minutes and 1 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 30 minutes and 1 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: c1ec091e-c4a4-4ca6-b872-dbc921545335

📥 Commits

Reviewing files that changed from the base of the PR and between f14cc13 and 9c87441.

📒 Files selected for processing (7)
  • prototypes/docusaurus/sidebars.ts
  • prototypes/docusaurus/src/constants/docsRoutes.ts
  • prototypes/docusaurus/src/pages/examples.module.css
  • prototypes/docusaurus/src/pages/examples.tsx
  • scripts/docs-layout.mjs
  • scripts/docs-layout.test.mjs
  • scripts/prepare-docs.mjs
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch jg-codex/examples-catalog

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

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 38e847e6f2

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread prototypes/docusaurus/src/pages/examples.tsx Outdated
Comment thread prototypes/docusaurus/src/pages/examples.tsx
@justin808 justin808 closed this Apr 19, 2026
@justin808 justin808 force-pushed the jg-codex/examples-catalog branch from bf8e179 to f14cc13 Compare April 19, 2026 21:27
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 1 potential issue.

Autofix Details

Bugbot Autofix prepared a fix for the issue found in the latest run.

  • ✅ Fixed: Three-column grid never filled by two-item sections
    • Updated the examples catalog .grid layout from three columns to two so section item counts no longer leave a permanent empty column.

Create PR

Or push these changes by commenting:

@cursor push 9b513da718
Preview (9b513da718)
diff --git a/prototypes/docusaurus/src/pages/examples.module.css b/prototypes/docusaurus/src/pages/examples.module.css
--- a/prototypes/docusaurus/src/pages/examples.module.css
+++ b/prototypes/docusaurus/src/pages/examples.module.css
@@ -51,7 +51,7 @@
 .grid {
   margin-bottom: 1.6rem;
   display: grid;
-  grid-template-columns: repeat(3, minmax(0, 1fr));
+  grid-template-columns: repeat(2, minmax(0, 1fr));
   gap: 0.9rem;
 }

You can send follow-ups to the cloud agent here.

Comment thread prototypes/docusaurus/src/pages/examples.module.css
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 19, 2026

Cloudflare preview deployed.

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 1 potential issue.

There are 2 total unresolved issues (including 1 from previous review).

Autofix Details

Bugbot Autofix prepared a fix for the issue found in the latest run.

  • ✅ Fixed: Link points to non-existent docs page
    • Replaced the hardcoded non-existent docs URL with the centralized docsRoutes.docsGuide route so the page now links to an existing docs entry.

Create PR

Or push these changes by commenting:

@cursor push 470a2e2cf6
Preview (470a2e2cf6)
diff --git a/prototypes/docusaurus/src/pages/examples.tsx b/prototypes/docusaurus/src/pages/examples.tsx
--- a/prototypes/docusaurus/src/pages/examples.tsx
+++ b/prototypes/docusaurus/src/pages/examples.tsx
@@ -204,9 +204,7 @@
             <h2>Use the docs for taxonomy and this page for curation.</h2>
             <p className={styles.sectionLead}>
               The canonical docs page for repo taxonomy lives in{' '}
-              <Link to="/docs/getting-started/examples-and-references">
-                Examples and migration references
-              </Link>
+              <Link to={docsRoutes.docsGuide}>the docs guide</Link>
               . This page is the marketing-forward catalog of the public repos we want people to
               find first.
             </p>

You can send follow-ups to the cloud agent here.

Comment thread prototypes/docusaurus/src/pages/examples.tsx Outdated
@justin808
Copy link
Copy Markdown
Member Author

Follow-up push on 9c87441:

  • added getting-started/examples-and-references.md to the subset docs source list
  • generated a subset-specific sidebar so prepare:subset produces a buildable docs tree instead of pairing a reduced doc set with the full upstream sidebar
  • switched the examples grids to auto-fit so the 1-, 2-, and 3-card sections all lay out cleanly

Local validation on this branch:

  • REACT_ON_RAILS_REPO=<paired react_on_rails checkout> npm run prepare:subset
  • npm run build after subset prep
  • REACT_ON_RAILS_REPO=<paired react_on_rails checkout> npm run prepare && npm run build

Both builds succeeded; the remaining Docusaurus broken-link / broken-anchor warnings are the same pre-existing set already present before this follow-up.

Merge order for the stack is still: shakacode/react_on_rails#3191 first, then this PR.

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: Subset sidebar includes documented redirect stub as navigable item
    • I replaced the subset sidebar's pro/home-pro entry with a real Pro doc so the redirect stub is no longer shown as a navigable item.
  • ✅ Fixed: Subset sidebar omits synced node-renderer/basics doc entry
    • The subset sidebar now includes pro/node-renderer/basics, restoring navigation to that synced Pro doc.

Create PR

Or push these changes by commenting:

@cursor push 6585d33d99
Preview (6585d33d99)
diff --git a/scripts/prepare-docs.mjs b/scripts/prepare-docs.mjs
--- a/scripts/prepare-docs.mjs
+++ b/scripts/prepare-docs.mjs
@@ -743,7 +743,7 @@
       link: {type: 'generated-index', title: 'React on Rails Pro'},
       items: [
         'pro/react-on-rails-pro',
-        'pro/home-pro',
+        'pro/node-renderer/basics',
         'pro/react-server-components/tutorial',
       ],
     },

You can send follow-ups to the cloud agent here.

Reviewed by Cursor Bugbot for commit 9c87441. Configure here.

Comment thread scripts/prepare-docs.mjs
link: {type: 'generated-index', title: 'React on Rails Pro'},
items: [
'pro/react-on-rails-pro',
'pro/home-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.

Subset sidebar includes documented redirect stub as navigable item

Low Severity

The new subsetSidebarsContent() includes 'pro/home-pro' as a regular sidebar entry, but sidebars.ts now explicitly documents pro/home-pro as a URL-compatibility redirect stub excluded from navigation (redirecting to pro/react-on-rails-pro). In subset mode, users see both the canonical Pro page and its redirect stub as separate navigable items in the same sidebar category, which is confusing and inconsistent with the documented intent.

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 9c87441. Configure here.

Comment thread scripts/prepare-docs.mjs
'pro/home-pro',
'pro/react-server-components/tutorial',
],
},
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Subset sidebar omits synced node-renderer/basics doc entry

Low Severity

docsSubsetEntries includes {kind: "pro", relativePath: "node-renderer/basics.md"}, but the new subsetSidebarsContent() "React on Rails Pro" category doesn't list 'pro/node-renderer/basics'. The file gets synced into the docs directory in subset mode, but no sidebar links to it, creating an orphan doc with no navigation path.

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 9c87441. Configure here.

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