Add DevContainer CLI guide, v2 migration guide, and full docs review#36
Merged
AnExiledDev merged 2 commits intomainfrom Feb 27, 2026
Merged
Add DevContainer CLI guide, v2 migration guide, and full docs review#36AnExiledDev merged 2 commits intomainfrom
AnExiledDev merged 2 commits intomainfrom
Conversation
New pages: - DevContainer CLI guide (Getting Started) — terminal-only workflow without VS Code: build, connect, port forwarding, key differences - Migrating to v2 (Getting Started) — path changes, automatic migration, manual steps, breaking changes, troubleshooting Updated pages: - Port Forwarding — VS Code dependency warning, dbr platform matrix - Installation — slimmed from 318 to 231 lines; moved troubleshooting to reference page, trimmed CLI tab to summary + link - Troubleshooting — merged installation-specific entries (npx failures, VS Code extension, Docker permissions, WSL 2, port conflicts) - Agents — documented 4 missing agents (implementer, investigator, tester, documenter); updated count from 11 to 15 new specialists - Commands — removed 29-line ccms usage section for disabled feature - Configuration — added missing git-workflow and prompt-snippets to enabledPlugins example - First Session — added cc-orc to launch commands table - Environment — added CONFIG_SOURCE_DIR deprecation note - Agent System — improved magic-docs explanation - CodeForge LSP — clarified "no hook scripts" vs "no configuration" - Reference index — clarified plugin count as "13 local + 1 official" - Sidebar — added DevContainer CLI and Migrating to v2 entries Validated: npm run build passes with 42 pages, all internal links valid.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review infoConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (4)
📝 WalkthroughWalkthroughThis PR expands and reorganizes CodeForge documentation: adds DevContainer CLI and Migrating to v2 guides, shifts installation to a CLI-first flow, adds four agent specialists, enables two plugins, updates environment variable docs to CODEFORGE_DIR, and enhances troubleshooting and port-forwarding references. Changes
Sequence Diagram(s)(omitted — changes are documentation-only and do not alter runtime control flow) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
docs/src/content/docs/reference/troubleshooting.md (1)
16-16: Avoid recommending global npm install withsudoin primary troubleshooting guidance.Line 16 suggests
sudo npm install -g codeforge-dev; this can create permission and security issues on developer machines. Prefernpx --yes codeforge-dev(already listed) and, if needed, recommend fixing npm prefix/nvm instead ofsudo.Suggested doc tweak
-- **Permission errors** — on some systems, global npm installs need `sudo`. Try `npx --yes codeforge-dev` or install globally with `sudo npm install -g codeforge-dev`. +- **Permission errors** — prefer `npx --yes codeforge-dev` to avoid global install permission issues. If you need global installs, configure npm prefix or use a Node version manager (e.g., nvm) instead of `sudo`.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/src/content/docs/reference/troubleshooting.md` at line 16, Replace the problematic recommendation in the "**Permission errors**" troubleshooting bullet that suggests "sudo npm install -g codeforge-dev": remove the `sudo` global install suggestion and instead keep the safer `npx --yes codeforge-dev` option and add a short note advising users to fix their npm permissions via nvm or adjusting npm prefix/ownership; update the sentence mentioning "sudo npm install -g codeforge-dev" to recommend repairing npm permissions (or using nvm) rather than using `sudo`.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.devcontainer/CHANGELOG.md:
- Around line 17-29: The "#### Documentation" subsection mixes new additions and
modifications; split it into two subsections under the Unreleased block: create
a new "### Added" and move truly new entries (e.g., "Added DevContainer CLI
guide", "Added v2 Migration Guide", "Full documentation review", "Documented 4
previously undocumented agents", and "Added missing git-workflow and
prompt-snippets to configuration.md enabledPlugins example") into "### Added",
and leave or move the changed items (e.g., "Updated Port Forwarding reference",
"Slimmed Installation page", "Trimmed disabled ccms usage section", "Clarified
codeforge-lsp plugin description", "Improved magic-docs agent explanation",
"Clarified plugin count", and "Added CONFIG_SOURCE_DIR deprecation note" and
"Added cc-orc orchestrator command to first-session launch commands table" if
they are modifications) under "### Changed"; ensure headings are in the
Unreleased block and that each entry is placed under the appropriate heading per
the changelog guidelines.
In `@docs/src/content/docs/features/agents.md`:
- Line 33: Remove "architect" from the "entirely new specialists" sentence and
list in the paragraph that begins "Beyond the six replacements, CodeForge adds
**15 entirely new specialists**..." so the count and items match (i.e., keep the
count at 15 and delete the `architect` token from the comma-separated list),
ensuring the phrase now lists only the truly new agents like debug-logs,
dependency-analyst, doc-writer, documenter, git-archaeologist, implementer,
investigator, migrator, perf-profiler, refactorer, researcher, security-auditor,
spec-writer, tester, and test-writer.
In `@docs/src/content/docs/getting-started/devcontainer-cli.md`:
- Line 16: Update the sentence that currently reads "Requires Node.js 18+" to
accurately reflect the CLI's supported Node versions and the standalone
installer: change it to state that the CLI supports Node.js ^16.13.0
(16.13.0–17.x) and >=18.0.0 (e.g., "Requires Node.js ^16.13.0 or >=18.0.0; you
can also use the standalone install script which bundles Node.js"), and keep the
verification command `devcontainer --version` unchanged so users can confirm the
installation.
---
Nitpick comments:
In `@docs/src/content/docs/reference/troubleshooting.md`:
- Line 16: Replace the problematic recommendation in the "**Permission errors**"
troubleshooting bullet that suggests "sudo npm install -g codeforge-dev": remove
the `sudo` global install suggestion and instead keep the safer `npx --yes
codeforge-dev` option and add a short note advising users to fix their npm
permissions via nvm or adjusting npm prefix/ownership; update the sentence
mentioning "sudo npm install -g codeforge-dev" to recommend repairing npm
permissions (or using nvm) rather than using `sudo`.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (16)
.devcontainer/CHANGELOG.mddocs/astro.config.mjsdocs/src/content/docs/customization/configuration.mddocs/src/content/docs/features/agents.mddocs/src/content/docs/getting-started/devcontainer-cli.mddocs/src/content/docs/getting-started/first-session.mddocs/src/content/docs/getting-started/index.mddocs/src/content/docs/getting-started/installation.mddocs/src/content/docs/getting-started/migrating-to-v2.mddocs/src/content/docs/plugins/agent-system.mddocs/src/content/docs/plugins/codeforge-lsp.mddocs/src/content/docs/reference/commands.mddocs/src/content/docs/reference/environment.mddocs/src/content/docs/reference/index.mddocs/src/content/docs/reference/port-forwarding.mddocs/src/content/docs/reference/troubleshooting.md
💤 Files with no reviewable changes (1)
- docs/src/content/docs/reference/commands.md
| npm install -g @devcontainers/cli | ||
| ``` | ||
|
|
||
| Requires Node.js 18+. Verify the installation with `devcontainer --version`. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "=== Checking `@devcontainers/cli` package engines ==="
curl -fsSL https://unpkg.com/@devcontainers/cli@latest/package.json | jq -r '.engines.node'
echo ""
echo "=== Checking latest version info ==="
curl -fsSL https://registry.npmjs.org/@devcontainers/cli/latest | jq '{version: .version, engines: .engines}'Repository: AnExiledDev/CodeForge
Length of output: 256
🌐 Web query:
@devcontainers/cli Node.js version requirements official documentation
💡 Result:
- If installing
@devcontainers/clivia npm: the package’senginesfield requires Node.js^16.13.0 || >=18.0.0. [1] - If using the standalone install script: it downloads a bundled Node.js runtime, so no pre-installed Node.js is required for that install path. [2]
- Note: the VS Code Dev Containers CLI page still states “Node.js (version 14 or greater)” for npm install, which may be outdated relative to the package’s current
enginesrequirement. [3]
Sources: [1] [2] [3]
Line 16 incorrectly restricts the Node.js requirement to 18+ when the CLI supports Node.js 16.13.0 and above.
The @devcontainers/cli package's actual engine requirement is ^16.13.0 || >=18.0.0, so users with Node.js 16.13.0–17.x will be unnecessarily discouraged.
Additionally, users can bypass Node.js pre-installation entirely by using the standalone install script (which bundles its own Node.js runtime).
Suggested update
-Requires Node.js 18+. Verify the installation with `devcontainer --version`.
+Requires Node.js 16.13.0 or higher (when installing via npm). Alternatively, use the standalone install script which includes a bundled Node.js runtime. Verify the installation with `devcontainer --version`.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| Requires Node.js 18+. Verify the installation with `devcontainer --version`. | |
| Requires Node.js 16.13.0 or higher (when installing via npm). Alternatively, use the standalone install script which includes a bundled Node.js runtime. Verify the installation with `devcontainer --version`. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/src/content/docs/getting-started/devcontainer-cli.md` at line 16, Update
the sentence that currently reads "Requires Node.js 18+" to accurately reflect
the CLI's supported Node versions and the standalone installer: change it to
state that the CLI supports Node.js ^16.13.0 (16.13.0–17.x) and >=18.0.0 (e.g.,
"Requires Node.js ^16.13.0 or >=18.0.0; you can also use the standalone install
script which bundles Node.js"), and keep the verification command `devcontainer
--version` unchanged so users can confirm the installation.
- Split changelog entries into proper Added/Changed sections - Remove architect from "entirely new" agent list (it's a Plan replacement) - Fix Node.js version requirement: 16.13+ or 18+, not just 18+ - Replace sudo npm install recommendation with nvm/npm-prefix advice
This was referenced Feb 27, 2026
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
.codeforge/config externalization (path changes, automatic migration, manual steps, breaking changes, troubleshooting)Pages updated (14 existing + 2 new)
dbrplatform support matrix, CLI guide cross-linkcc-orcorchestrator command to launch tableCONFIG_SOURCE_DIRdeprecation note onCODEFORGE_DIRTest plan
npm run buildindocs/— 42 pages built, all internal links validSummary by CodeRabbit
Documentation
New Features