Skip to content

Docs: move internal-only docs out of published docs trees#2414

Open
justin808 wants to merge 2 commits intomasterfrom
codex/internal-docs-rehome
Open

Docs: move internal-only docs out of published docs trees#2414
justin808 wants to merge 2 commits intomasterfrom
codex/internal-docs-rehome

Conversation

@justin808
Copy link
Member

@justin808 justin808 commented Feb 15, 2026

Summary

  • move internal-only docs from published paths into internal/
  • relocate:
    • docs/contributor-info/ -> internal/contributor-info/
    • docs/planning/ -> internal/planning/
    • react_on_rails_pro/docs/contributors-info/ -> internal/react_on_rails_pro/contributors-info/
  • update contributor/doc index links to new internal paths
  • add internal/README.md documenting placement rules

Why

  • keeps user-facing docs clean and publishable
  • prevents internal process docs from being mixed with end-user docs
  • reduces confusion for contributors and AI agents

Scope

  • docs path relocations via git mv
  • link updates in:
    • CONTRIBUTING.md
    • react_on_rails_pro/CONTRIBUTING.md
    • SUMMARY.md
    • docs/misc/doctrine.md
    • internal/react_on_rails_pro/contributors-info/releasing.md

Notes

Verification

  • git mv preserves history for moved docs
  • no runtime code changes

Summary by CodeRabbit

  • Documentation
    • Reorganized internal contributor documentation structure for improved organization.
    • Updated documentation links across multiple files to reflect new internal documentation paths.
    • Added guidelines clarifying the separation between user-facing and internal documentation.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 15, 2026

Walkthrough

Documentation references are being reorganized across the codebase, with links migrated from docs/contributor-info/ to internal/contributor-info/ paths. A new internal/README.md is introduced to document the structure and placement rules for internal documentation.

Changes

Cohort / File(s) Summary
CONTRIBUTING files
CONTRIBUTING.md, react_on_rails_pro/CONTRIBUTING.md
Updated contributor-info documentation links from docs/ to internal/ directory paths in CI optimization and generator testing references.
Documentation structure and references
SUMMARY.md, docs/misc/doctrine.md, internal/README.md
Updated cross-references to contributor-info paths; added new README documenting internal documentation structure, placement rules, and directory organization for internal vs. user-facing documentation.
Internal contributor info
internal/react_on_rails_pro/contributors-info/releasing.md
Updated relative link reference to point to internal contributor-info releasing documentation instead of docs path.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Documentation hops to a new home today,
From docs/ to internal/, organized and on display,
With README to guide where each doc should stay,
Our references dance in a cleaner way! 🌿✨

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: moving internal-only documentation from published docs trees to a new internal directory structure.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into master

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch codex/internal-docs-rehome

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.

@greptile-apps
Copy link

greptile-apps bot commented Feb 15, 2026

Greptile Summary

This PR reorganizes internal documentation by moving contributor-info and planning docs from published docs/ paths to a new internal/ directory. All link references in CONTRIBUTING.md, SUMMARY.md, and Pro contributing docs have been updated to point to the new locations. A new internal/README.md clearly documents the placement rules.

Key changes:

  • Moved docs/contributor-info/internal/contributor-info/ (7 files)
  • Moved docs/planning/internal/planning/ (9 files)
  • Moved react_on_rails_pro/docs/contributors-info/internal/react_on_rails_pro/contributors-info/ (3 files)
  • Updated all references in contributing docs and summary index
  • In docs/misc/doctrine.md, the linters link was changed from the internal contributor doc to the user-facing style guide, which is appropriate for published docs

Uncovered references:

  • AGENTS.md line 89 still references docs/contributor-info/ - PR description notes this was intentionally skipped to avoid conflict with PR Docs: Clarify .client/.server suffixes vs 'use client' RSC directive #2406
  • .claude/docs/analysis/CI_OPTIMIZATION_SUMMARY.md has 3 references to old paths
  • Several internal planning docs reference old paths (expected as they're historical)

Confidence Score: 4/5

  • This PR is safe to merge with minimal risk - it's purely documentation reorganization
  • Score reflects that this is a straightforward docs reorganization using git mv (preserves history) with no runtime code changes. All primary link references have been updated correctly. Minor deduction because some references in AGENTS.md and .claude/docs/ still point to old paths, though the AGENTS.md omission was intentional per PR description.
  • Check AGENTS.md line 89 and .claude/docs/analysis/CI_OPTIMIZATION_SUMMARY.md for stale path references in follow-up

Important Files Changed

Filename Overview
CONTRIBUTING.md Updated 6 links from docs/contributor-info/ to internal/contributor-info/ correctly
SUMMARY.md Updated 3 contributor doc links to new internal/ paths correctly
internal/README.md New file documenting internal doc placement rules clearly
docs/misc/doctrine.md Link changed from ../contributor-info/linters.md to ./style.md - may be incorrect redirect
react_on_rails_pro/CONTRIBUTING.md Updated 2 relative paths to new internal/contributor-info/ location correctly
internal/react_on_rails_pro/contributors-info/releasing.md New file with correct relative link to ../../contributor-info/releasing.md

Last reviewed commit: 19ff55d

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

24 files reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

- 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)
Copy link

Choose a reason for hiding this comment

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

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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)
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 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 -20

Repository: 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.md

Repository: 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 -20

Repository: 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.md

Repository: 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).

@justin808 justin808 added the codex PRs created from codex-named branches label Feb 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

codex PRs created from codex-named branches docs-cleanup Documentation cleanup or migration owner:justin808 Primary owner justin808 P1 Target this sprint

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant