Skip to content

Commit 7dd9ede

Browse files
justin808claude
andauthored
Remove Contributing section from docs sidebar (#3064)
## Summary - Removes the top-level `Contributing` section (doctrine, style, updating-dependencies, credits) and nested `Resources` (articles, tips) from the primary docs sidebar - Adds a Contributing section with links to all 6 pages at the bottom of the introduction page, keeping them reachable - All underlying pages remain published at their existing URLs Fixes #2928 ## Test plan - [ ] Verify docs sidebar no longer shows Contributing or Resources sections - [ ] Verify introduction page has Contributing section with links to all 6 pages - [ ] Verify each linked page (`doctrine`, `style`, `updating-dependencies`, `credits`, `articles`, `tips`) is accessible via the introduction page links 🤖 Generated with [Claude Code](https://claude.com/claude-code) <!-- CURSOR_SUMMARY --> --- > [!NOTE] > **Low Risk** > Low risk documentation-only navigation change; main risk is discoverability/regression in docs navigation if links/URLs are misconfigured. > > **Overview** > Removes the **Contributing** (and nested **Resources**) section from the Docusaurus `docsSidebar` so those pages no longer appear in the primary navigation. > > Adds a **Contributing** section to `docs/oss/introduction.md` with direct links to the same six docs pages, keeping them accessible at their existing URLs. > > <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit 2783ce5. Bugbot is set up for automated code reviews on this repo. Configure [here](https://www.cursor.com/dashboard/bugbot).</sup> <!-- /CURSOR_SUMMARY --> <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized contributing documentation navigation by moving the "Contributing" section from the sidebar to the introduction page, with direct links to related guides including Doctrine, Code Style, Updating Dependencies, Credits, and Resources. <!-- end of auto-generated comment: release notes by coderabbit.ai --> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent af84c21 commit 7dd9ede

2 files changed

Lines changed: 17 additions & 16 deletions

File tree

docs/oss/introduction.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,15 @@ Read the full **[React on Rails Doctrine](./misc/doctrine.md)** for our design p
136136
- **[React Documentation](https://react.dev)** - Official React documentation
137137
- **[Rails Guides](https://guides.rubyonrails.org)** - Ruby on Rails documentation
138138

139+
## Contributing
140+
141+
- **[React on Rails Doctrine](./misc/doctrine.md)** - Our design philosophy
142+
- **[Code Style](./misc/style.md)** - Coding style guidelines
143+
- **[Updating Dependencies](./misc/updating-dependencies.md)** - How to keep Ruby and JS dependencies current
144+
- **[Credits](./misc/credits.md)** - Authors and contributors
145+
- **[Articles, Videos, and Podcasts](./misc/articles.md)** - Community content
146+
- **[Tips](./misc/tips.md)** - Practical tips for working with React on Rails
147+
139148
---
140149

141150
**Ready to start?** Pick your path above and let's build something great! 🚀

docs/sidebars.ts

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
55
// - building-features/rails-webpacker-react-integration-options
66
// - deployment/troubleshooting-when-using-webpacker
77
// - misc/asset-pipeline
8+
//
9+
// Contributing/Resources pages (linked from introduction.md instead of sidebar):
10+
// - misc/doctrine
11+
// - misc/style
12+
// - misc/updating-dependencies
13+
// - misc/credits
14+
// - misc/articles
15+
// - misc/tips
816

917
const sidebars: SidebarsConfig = {
1018
docsSidebar: [
@@ -222,22 +230,6 @@ const sidebars: SidebarsConfig = {
222230
},
223231
],
224232
},
225-
{
226-
type: 'category',
227-
label: 'Contributing',
228-
link: { type: 'generated-index', title: 'Contributing' },
229-
items: [
230-
'misc/doctrine',
231-
'misc/style',
232-
'misc/updating-dependencies',
233-
'misc/credits',
234-
{
235-
type: 'category',
236-
label: 'Resources',
237-
items: ['misc/articles', 'misc/tips'],
238-
},
239-
],
240-
},
241233
],
242234
};
243235

0 commit comments

Comments
 (0)