Comprehensive CLAUDE.md and AGENTS.md update
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 50/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- javascript, rails, react, webpack
- Domain
- build-system, devops, documentation, full-stack, testing
Research direction
Start by reading CLAUDE.md, AGENTS.md, and the existing Conductor Compatibility guidance in bin/conductor-exec. Then inspect the project architecture, ror_components/, Procfile.dev, testing locations, and deployment references named in the issue. Done means both documents accurately cover the listed architecture, conventions, build and test workflows, deployment details, and retained existing topics.
Written by the indexing model from the issue text.
Description
Follow-up after the Pro RSC migration (#727).
Current state
CLAUDE.md(56 lines): single topic — Conductor Compatibility wrapper (bin/conductor-exec). No coverage of project architecture, Rails patterns, React conventions, ReScript, Stimulus, comments DB, build system, or anything else.AGENTS.md(12 lines): two short sections (Project Overview + Working Rules). Project Overview line was factually outdated by #727 (still references "react_on_rails gem" without Pro / NodeRenderer / RSC).
Goal
Make both docs map to the actual project surface so future agents (Claude, Codex, GPT, others) can pick up tasks without needing to grep their way through the codebase first.
Suggested scope
- Architecture map: client / server SSR / RSC bundles, the Pro Node Renderer, the auto-bundling registration flow.
- Conventions: ROR component placement (
ror_components/for auto-bundling),'use client'directive rules for entry-point modules, controller-props pattern for RSC data fetching. - Build / dev: env-var dispatch (`RSC_BUNDLE_ONLY`, `SERVER_BUNDLE_ONLY`), the six `Procfile.dev` processes, where the RSC demo lives.
- Testing: where request specs and system specs live, how rspec / lint workflows trigger.
- Deployment: Control Plane + Pro license env vars, review-app provisioning trigger.
- Existing topics already in CLAUDE.md (Conductor Compatibility) — keep, don't replace.
Why deferred
A correctness-only patch on AGENTS.md or a Pro/RSC-only addition to CLAUDE.md would leave both docs lopsided. A comprehensive overhaul is the right shape and is out of scope for the migration PR.
- Dominant language
- JavaScript
- Stars
- 1.7k
- Forks
- 370
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 6
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from shakacode/react-webpack-rails-tutorial
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 42/100
shakacode/react-webpack-rails-tutorial#731 · 1 comment ·
-
question
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 28/100
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 45/100
All issues in shakacode/react-webpack-rails-tutorial
Similar issues
-
code-quality refactoring
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
github/gh-aw-firewall#8816 ·
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
githubnext/gh-aw-cao#13143 ·
-
status: needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100