AGENTS: point internal docs paths to /internal

[justin808]

Summary

• update AGENTS project-structure table to reflect internal docs moved under internal/
• replace stale docs/contributor-info/ entry with:
  • internal/contributor-info/
  • internal/planning/
  • internal/react_on_rails_pro/contributors-info/

Why

• keeps agent guidance aligned with docs cleanup PR Docs: move internal-only docs out of published docs trees #2414
• reduces path confusion for human contributors and AI agents

Scope

• AGENTS.md only

Notes

• intentionally limited to the project-structure table to keep overlap with Docs: Clarify .client/.server suffixes vs 'use client' RSC directive #2406 minimal

Summary by CodeRabbit

• Documentation
  • Updated internal documentation structure and organization.

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

Walkthrough

AGENTS.md documentation table updated to restructure contributor information paths. A docs/contributor-info/ entry is removed and replaced with three internal paths: internal/contributor-info/, internal/planning/, and internal/react_on_rails_pro/contributors-info/. These internal paths are not published to the website.

Changes

Cohort / File(s)	Summary
Documentation restructuring AGENTS.md	Removed public-facing contributor-info path and added three internal documentation paths with corresponding formatting adjustments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 Documentation hops along so neat,
Path restructuring complete!
Internal paths now tuck away,
While agents guide us every day. ✨

🚥 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 clearly and specifically describes the main change: updating AGENTS.md to point internal documentation paths to the /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/agents-internal-doc-paths

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[justin808]

Leaving this as Draft so it merges after #2414 (which introduces the internal paths).

[greptile-apps]

Greptile Summary

Updates the project structure table in AGENTS.md to reference new internal/ directories (internal/contributor-info/, internal/planning/, internal/react_on_rails_pro/contributors-info/) instead of the old docs/contributor-info/ path.

Major issues:

• The internal/ directory and its subdirectories don't exist yet in the repository - these paths will be broken until PR Docs: move internal-only docs out of published docs trees #2414 is merged
• This creates a merge order dependency that could result in broken documentation on master if merged before Docs: move internal-only docs out of published docs trees #2414

Confidence Score: 2/5

• This PR has a critical merge order dependency that will break documentation references if not handled correctly
• While the changes themselves are correct and well-formatted, the PR references directories that don't exist yet in the repository. Merging this before PR Docs: move internal-only docs out of published docs trees #2414 (which creates the internal/ directories) will result in broken documentation paths. This is a documentation-only change with no code impact, but the merge sequencing issue is significant.
• AGENTS.md requires attention due to non-existent path references

Important Files Changed

Filename	Overview
AGENTS.md	Updates project structure table to reference internal/ directories that don't exist yet in the repository

_{Last reviewed commit: daf5763}

[greptile-apps]

_{1 file reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}

[greptile-apps]

The internal/ directory doesn't exist yet in the repository. These paths will be broken until PR #2414 is merged. Consider merging #2414 first, or ensuring both PRs are merged in the correct order to avoid having broken documentation references on master.

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@AGENTS.md`:
- Around line 89-91: The AGENTS.md lines list internal directories
(`internal/contributor-info/`, `internal/planning/`,
`internal/react_on_rails_pro/contributors-info/`) that do not exist; either
remove these entries from AGENTS.md or complete the planned reorganization and
update all references to the old path (`docs/contributor-info/`) across the repo
(e.g., CONTRIBUTING.md, SUMMARY.md, react_on_rails_pro/CONTRIBUTING.md) so they
point to the new directories; pick one approach, then ensure AGENTS.md
accurately reflects the actual directory structure and commit the corresponding
moves/renames or deletions.

🧹 Nitpick comments (1)

AGENTS.md (1)

89-91: Minor naming inconsistency in directory paths.

The paths use inconsistent naming conventions:

• Line 89: internal/contributor-info/ (singular)
• Line 91: internal/react_on_rails_pro/contributors-info/ (plural with "s")

Consider standardizing to either contributor-info or contributors-info throughout for consistency, though this may depend on the actual directory names from PR #2414.

[coderabbitai]

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify that the new internal directories exist
echo "Checking if new directories exist..."
for dir in "internal/contributor-info" "internal/planning" "internal/react_on_rails_pro/contributors-info"; do
  if [ -d "$dir" ]; then
    echo "✓ $dir exists"
  else
    echo "✗ $dir NOT FOUND"
  fi
done

echo ""
echo "Checking for any remaining references to old path..."
rg -n "docs/contributor-info" --type md

echo ""
echo "Checking all directory references in the codebase..."
rg -n "contributor-info|contributors-info" --type md -A 2 | head -50

Repository: shakacode/react_on_rails

Length of output: 7375

---

Remove entries documenting non-existent directories or confirm the planned directory reorganization has been implemented.

The verification found that all three new internal directories referenced in these lines do not exist in the repository:

• internal/contributor-info/
• internal/planning/
• internal/react_on_rails_pro/contributors-info/

Additionally, the old docs/contributor-info/ path still exists and remains referenced throughout the codebase in CONTRIBUTING.md, SUMMARY.md, react_on_rails_pro/CONTRIBUTING.md, and other files. Either these entries should be removed from AGENTS.md if they document a future plan not yet implemented, or the directory reorganization must be fully completed (including moving content and updating all references) before documenting them as the current structure.

🤖 Prompt for AI Agents

In `@AGENTS.md` around lines 89 - 91, The AGENTS.md lines list internal
directories (`internal/contributor-info/`, `internal/planning/`,
`internal/react_on_rails_pro/contributors-info/`) that do not exist; either
remove these entries from AGENTS.md or complete the planned reorganization and
update all references to the old path (`docs/contributor-info/`) across the repo
(e.g., CONTRIBUTING.md, SUMMARY.md, react_on_rails_pro/CONTRIBUTING.md) so they
point to the new directories; pick one approach, then ensure AGENTS.md
accurately reflects the actual directory structure and commit the corresponding
moves/renames or deletions.