docs: comprehensive README and CLAUDE.md improvements - #60
Merged
Conversation
Add "Dockerized Claude Code" subtitle so new visitors immediately understand what the name means. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
New users who don't have Docker installed will hit a confusing error. This makes the requirement explicit upfront. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Tell users what to expect on first launch (image pull + auth prompt) so they don't think the tool is broken during the initial setup. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The container isolation benefit is the strongest differentiator. Move it from last to first position in the "Why dclaude?" list without changing the overall tagline. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
A passing build badge signals active maintenance and working code. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The dclaude script is bash and the npm package excludes Windows. Make it explicit that WSL2 is required on Windows. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
New users may not realize the unprefixed config file variables map to the prefixed environment variables. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
SSH Authentication and SSH Key/Server Management are related but serve different purposes. Add cross-references so users find both. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This is the most user-facing of the undocumented env vars, enabling named concurrent sessions. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Path mirroring is the core innovation. A simple visual makes the concept click faster than bullet points alone. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
aws login is a valid newer AWS CLI command that supersedes aws sso login for SSO flows while also supporting IAM users. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Document previously undiscoverable subcommands: new, attach, stop, rm, pull, update, shell. Placed in its own section between Features and Environment Variables to keep Basic Usage focused. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This subcommand bridges the gap between SSH auth (keys) and git identity (name/email for commits). Was documented in CLAUDE.md but completely absent from user-facing README. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The previous 2-line Chrome section omitted --port, --setup-only, profile configuration, and how the architecture works (Chrome on host, MCP in container). Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Completions for bash and zsh exist in completions/ but there was no guidance on how to install them. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
CI builds both architectures but this was not mentioned anywhere in the README. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This env var is baked into the Dockerfile but was undocumented. Explain why it's set (container isolation replaces workspace trust) so contributors understand the security model. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
These scripts were added to the Dockerfile but missing from the README project structure listing. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
These fixed bugs are already guarded against by the "Critical Tmux Configuration" section which documents the correct settings and why they matter. The "Fixed" subsection added noise without new info. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The shields.io Docker Hub version badge returns "invalid response data". Replace with the working Docker pulls badge (shows 2.2k), which also serves as a social proof signal. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Claude Code now uses native binary installation, not npm. Remove outdated Node.js/npm pain points and add the filesystem access concern which is more relevant. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
The placeholder /path/to/dclaude/ was broken for npm users. Use $(npm root -g) to resolve the actual install location, and show the source install path as an alternative. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
dclaude already warns when no keys are loaded and directs users to run 'dclaude ssh keys'. The old text implied manual ssh-add was required. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Mention Docker Desktop, OrbStack, and Colima as examples rather than only Docker, since many users use alternative runtimes. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis pull request introduces MCP server configuration for Chrome DevTools and comprehensively updates documentation to reflect a Dockerized Claude setup, including container management procedures, environment variables, authentication setup, and new utility scripts. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 Tip You can enable review details to help with troubleshooting, context usage and more.Enable the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive documentation overhaul based on a structured 3-perspective review (engineer, technical writer, marketing specialist) with cross-review debate and consensus synthesis.
Changes (24 commits, each reviewable independently)
Accuracy fixes
dclaude ssh keysaws loginis a valid newer AWS CLI commandclaude-launcher.shandtmux-wrapper.shNew content
stop,rm,pull,update,new,attach,shell)dclaude git--port,--setup-only, config optionsDCLAUDE_TMUX_SESSIONto env var tableCLAUDE_UNSAFE_TRUST_WORKSPACE=truein CLAUDE.md Security sectionImprovements
.dclaudevsDCLAUDE_*variable naming relationshipReview process
Three AI agents reviewed both files from different angles, then cross-reviewed each other's findings to challenge disagreements. Consensus was synthesized and approved before implementation.
Test plan
source "$(npm root -g)/@alanbem/dclaude/completions/dclaude.bash"🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
Documentation