Docs: trim First Session, expand Installation troubleshooting#4
Docs: trim First Session, expand Installation troubleshooting#4AnExiledDev merged 2 commits intomainfrom
Conversation
First Session: consolidate internals into summary with links, replace agent/skill tables with brief teasers (198 → 128 lines). Installation: add 6 troubleshooting entries for npx failures, VS Code extension issues, Docker permissions, WSL 2, port conflicts, slow rebuilds.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (5)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughDocumentation-only changes: consolidated first-session content, updated multiple pages to reflect 34 skills (was 21), and expanded installation troubleshooting with additional FAQ entries; changelogs updated to record these documentation edits. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.devcontainer/CHANGELOG.md (1)
8-9: Reword changelog entries to be user-facing rather than implementation-metric-focused.Line counts ("trimmed from 198 to 128 lines", "expanded from 4 to 10 FAQ entries") describe internal implementation details rather than the user-visible outcome. Per the changelog guideline, entries should reflect what changed for the reader, not how the work was measured.
✏️ Suggested rewording
- - **First Session page** — trimmed from 198 to 128 lines by consolidating "What Happens Automatically" into a concise summary, replacing full agent/skill tables with brief teasers linking to their dedicated pages + - **First Session page** — condensed for faster onboarding: "What Happens Automatically" is now a concise summary, and the agents/skills sections link out to their dedicated reference pages instead of embedding full tables - - **Installation Troubleshooting** — expanded from 4 to 10 FAQ entries covering `npx` failures, VS Code extension issues, Docker permissions on Linux, WSL 2 integration, port conflicts, and slow rebuilds + - **Installation Troubleshooting** — six new FAQ entries covering `npx` failures, VS Code extension issues, Docker permissions on Linux, WSL 2 integration, port conflicts, and slow rebuildsBased on learnings: "Write CHANGELOG entries from the user's perspective — what changed, not how it was implemented."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.devcontainer/CHANGELOG.md around lines 8 - 9, Reword the two changelog bullets that are currently metric-focused so they describe user-facing changes: replace the "**First Session page** — trimmed from 198 to 128 lines..." line with a description of the user impact (e.g., "First Session page: content consolidated for a clearer, shorter overview and links to detailed agent/skill pages"), and change the "**Installation Troubleshooting** — expanded from 4 to 10 FAQ entries..." line to something like "Installation Troubleshooting: added new FAQ entries covering npx failures, VS Code extension issues, Docker permissions on Linux, WSL2 integration, port conflicts, and slow rebuilds" so the entries state what changed for readers rather than line-count metrics; edit the bullets that start with "**First Session page**" and "**Installation Troubleshooting**" accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/src/content/docs/getting-started/first-session.md`:
- Line 99: Update the stale skill count in the sentence that reads "CodeForge
includes **17 specialized agents** and **21 skills**..." to use the corrected
skills total of 34 (so it reads "**17 specialized agents** and **34 skills**"),
and ensure the surrounding text remains grammatically unchanged; cross-check
against the v1.14.0 changelog entry that records "features: 21, agents: 17,
skills: 34" to confirm consistency with the docs.
---
Nitpick comments:
In @.devcontainer/CHANGELOG.md:
- Around line 8-9: Reword the two changelog bullets that are currently
metric-focused so they describe user-facing changes: replace the "**First
Session page** — trimmed from 198 to 128 lines..." line with a description of
the user impact (e.g., "First Session page: content consolidated for a clearer,
shorter overview and links to detailed agent/skill pages"), and change the
"**Installation Troubleshooting** — expanded from 4 to 10 FAQ entries..." line
to something like "Installation Troubleshooting: added new FAQ entries covering
npx failures, VS Code extension issues, Docker permissions on Linux, WSL2
integration, port conflicts, and slow rebuilds" so the entries state what
changed for readers rather than line-count metrics; edit the bullets that start
with "**First Session page**" and "**Installation Troubleshooting**"
accordingly.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
.devcontainer/CHANGELOG.mddocs/src/content/docs/getting-started/first-session.mddocs/src/content/docs/getting-started/installation.mddocs/src/content/docs/reference/changelog.md
CodeRabbit flagged that first-session.md referenced "21 skills" when the correct total across all plugins is 34 (skill-engine: 21, spec-workflow: 8, ticket-workflow: 4, agent-system: 1). The same stale count appeared in the Getting Started index, Features index headline, summary table, and skills section. Updated all CodeForge-wide references to 34; plugin-specific references (e.g., "Skill Engine — 21") remain correct in context.
Summary
Addresses external reviewer feedback on the Getting Started docs:
npxfailures, VS Code extension issues, Docker permissions (Linux), WSL 2 integration (Windows), port conflicts, and slow container rebuildsTest plan
npm run buildpasses with✓ All internal links are validSummary by CodeRabbit