Docs: move internal-only docs out of published docs trees#2414
Docs: move internal-only docs out of published docs trees#2414
Conversation
WalkthroughDocumentation references are being reorganized across the codebase, with links migrated from Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
Greptile SummaryThis PR reorganizes internal documentation by moving contributor-info and planning docs from published Key changes:
Uncovered references:
Confidence Score: 4/5
Important Files Changed
Last reviewed commit: 19ff55d |
| - React on Rails has taken the hard work out of figuring out the JavaScript tooling that works best with Rails. Not only could you spend lots of time researching different tooling, but then you'd have to figure out how to splice it all together. This is where a lot of "JavaScript fatigue" comes from. The following keep the code clean and consistent: | ||
| - [Style Guide](./style.md) | ||
| - [linters](../contributor-info/linters.md) | ||
| - [linters](./style.md) |
There was a problem hiding this comment.
Changed from linking to ../contributor-info/linters.md (detailed contributor guide with autofix instructions) to ./style.md (high-level style guide). Verify this redirect is intentional for user-facing docs.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/misc/doctrine.md`:
- Line 33: Remove the duplicate "linters" link from docs/misc/doctrine.md by
deleting the line that reads "[linters](./style.md)"; ensure the surrounding
list still renders correctly and that no other references to linters.md are
added in public docs (the internal file was moved to internal/contributor-info/
and should not be linked).
| - React on Rails has taken the hard work out of figuring out the JavaScript tooling that works best with Rails. Not only could you spend lots of time researching different tooling, but then you'd have to figure out how to splice it all together. This is where a lot of "JavaScript fatigue" comes from. The following keep the code clean and consistent: | ||
| - [Style Guide](./style.md) | ||
| - [linters](../contributor-info/linters.md) | ||
| - [linters](./style.md) |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check if docs/misc/doctrine.md exists and read it
echo "=== Checking docs/misc/doctrine.md ==="
if [ -f "docs/misc/doctrine.md" ]; then
echo "File exists. Full content:"
cat -n docs/misc/doctrine.md
else
echo "File not found"
fi
# Check for style.md in docs
echo -e "\n=== Searching for style.md ==="
fd -t f 'style.md' docs/
# Check for linters.md in internal directory
echo -e "\n=== Checking internal/contributor-info/ ==="
fd -t f 'linters.md' internal/
# List the docs directory structure to understand organization
echo -e "\n=== docs/ directory structure ==="
find docs -type d | head -20Repository: shakacode/react_on_rails
Length of output: 9277
🏁 Script executed:
#!/bin/bash
# Check docs/misc/style.md
echo "=== docs/misc/style.md ==="
wc -l docs/misc/style.md
echo "First 50 lines:"
head -50 docs/misc/style.md
# Check for linter-related content in style.md
echo -e "\n=== Searching for linter keywords in style.md ==="
rg -i "lint|eslint|rubocop|style" docs/misc/style.md | head -20
# Check internal/contributor-info/linters.md
echo -e "\n=== internal/contributor-info/linters.md ==="
wc -l internal/contributor-info/linters.md
echo "First 50 lines:"
head -50 internal/contributor-info/linters.mdRepository: shakacode/react_on_rails
Length of output: 4371
🏁 Script executed:
#!/bin/bash
# Check if there are any other links to internal/ directory in docs/
echo "=== Searching for links to internal/ in published docs ==="
rg "internal/" docs/ --type md
# Check README or contributor guidelines
echo -e "\n=== Checking for documentation policies ==="
fd -t f -i readme docs/ internal/ | head -10
# Check git history to see what the original link was
echo -e "\n=== Checking git diff for this file (if available) ==="
git log --oneline docs/misc/doctrine.md 2>/dev/null | head -5 || echo "Git history not available"
# Look for patterns in how internal docs are referenced
echo -e "\n=== Checking if internal/contributor-info/linters.md is referenced elsewhere ==="
rg "contributor-info/linters" --type md
# Check the internal directory structure to confirm it's internal-only
echo -e "\n=== Checking internal/ directory structure ==="
ls -la internal/ 2>/dev/null || echo "internal/ directory info"
fd -t f internal/ | head -20Repository: shakacode/react_on_rails
Length of output: 1601
🏁 Script executed:
#!/bin/bash
# Check SUMMARY.md to see the context
echo "=== SUMMARY.md context around Linting ==="
cat SUMMARY.md | grep -A5 -B5 "Linting"
# Check if doctrine.md is referenced in SUMMARY.md
echo -e "\n=== Checking if doctrine.md is in SUMMARY.md ==="
rg "doctrine" SUMMARY.mdRepository: shakacode/react_on_rails
Length of output: 651
Remove the "linters" line entirely.
Lines 32-33 now both link to ./style.md, creating a duplicate. As part of this PR's reorganization, linters.md was moved to internal/contributor-info/, which is internal-only documentation that shouldn't be linked from published docs. Rather than creating a duplicate link to style.md, delete the "linters" line to keep the documentation clean and consistent with the policy separating published and internal documentation.
🤖 Prompt for AI Agents
In `@docs/misc/doctrine.md` at line 33, Remove the duplicate "linters" link from
docs/misc/doctrine.md by deleting the line that reads "[linters](./style.md)";
ensure the surrounding list still renders correctly and that no other references
to linters.md are added in public docs (the internal file was moved to
internal/contributor-info/ and should not be linked).
Summary
internal/docs/contributor-info/->internal/contributor-info/docs/planning/->internal/planning/react_on_rails_pro/docs/contributors-info/->internal/react_on_rails_pro/contributors-info/internal/README.mddocumenting placement rulesWhy
Scope
git mvCONTRIBUTING.mdreact_on_rails_pro/CONTRIBUTING.mdSUMMARY.mddocs/misc/doctrine.mdinternal/react_on_rails_pro/contributors-info/releasing.mdNotes
AGENTS.mdin this PR to avoid overlap with open PR Docs: Clarify .client/.server suffixes vs 'use client' RSC directive #2406Verification
git mvpreserves history for moved docsSummary by CodeRabbit