Skip to content

Commit 7b9196e

Browse files
authored
Merge pull request #4 from AnExiledDev/docs/feedback-updates
Docs: trim First Session, expand Installation troubleshooting
2 parents d2ba55e + c5277a7 commit 7b9196e

File tree

6 files changed

+75
-83
lines changed

6 files changed

+75
-83
lines changed

.devcontainer/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
## [v1.14.2] - 2026-02-24
44

5+
### Changed
6+
7+
#### Docs
8+
- **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
9+
- **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
10+
511
### Fixed
612

713
#### CI: Release Workflow (v1.14.1)
@@ -18,6 +24,7 @@
1824

1925
#### Docs
2026
- **Active sidebar item** — increased background opacity from 0.08 to 0.14, added `font-weight: 600` and `color: var(--sl-color-accent-high)` for readable contrast against inactive items
27+
- **Stale skill counts** — 5 pages (First Session, Getting Started index, Features index) referenced "21 skills" instead of the correct total of 34 across all plugins (skill-engine: 21, spec-workflow: 8, ticket-workflow: 4, agent-system: 1)
2128

2229
## [v1.14.0] - 2026-02-24
2330

docs/src/content/docs/features/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This section is your reference guide to everything CodeForge provides. Whether y
1414
Out of the box, CodeForge gives you:
1515

1616
- **17 specialized AI agents** with focused expertise and safety-calibrated tool access
17-
- **21 domain knowledge packs** (skills) for frameworks, patterns, and workflows
17+
- **34 domain knowledge packs** (skills) for frameworks, patterns, and workflows
1818
- **21 CLI tools** for session management, code quality, and development
1919
- **3 layers of code intelligence** — AST-based search, syntax parsing, and LSP semantic analysis
2020
- **12 plugins** that wire everything together with hooks, guards, and automation
@@ -43,7 +43,7 @@ Key safety features set CodeForge agents apart:
4343

4444
## Skills
4545

46-
**21 domain-specific knowledge packs** give Claude deep expertise in frameworks, patterns, and workflows. When you start discussing FastAPI routes or Svelte 5 runes, the skill engine detects the context and auto-suggests the relevant skill. Once loaded, the skill injects structured knowledge — best practices, code patterns, API references, and common pitfalls — directly into Claude's context for the current task.
46+
**34 domain-specific knowledge packs** give Claude deep expertise in frameworks, patterns, and workflows. The skill engine provides 21 core skills covering frameworks, practices, and Claude/CodeForge topics. Additional skills come from the spec-workflow (8), ticket-workflow (4), and agent-system (1) plugins. When you start discussing FastAPI routes or Svelte 5 runes, the skill engine detects the context and auto-suggests the relevant skill. Once loaded, the skill injects structured knowledge — best practices, code patterns, API references, and common pitfalls — directly into Claude's context for the current task.
4747

4848
Each skill is built around a "mental model" — a concise explanation of how a technology works, followed by concrete patterns, code examples, and guidance. This is not generic documentation; skills encode the kind of working knowledge a senior specialist carries.
4949

@@ -55,7 +55,7 @@ Skills cover three categories:
5555
| **Practices** | Testing, Debugging, Security, Refactoring, API Design | Methodology, checklists, and established patterns |
5656
| **Claude & CodeForge** | Agent SDK, Headless Mode, Skill Building, Spec Writing | Guidance for building on and extending CodeForge itself |
5757

58-
[View all 21 skills →](./skills/)
58+
[View all 34 skills →](./skills/)
5959

6060
## CLI Tools
6161

@@ -90,7 +90,7 @@ CodeForge installs LSP servers for Python (Pyright), TypeScript/JavaScript, and
9090
| Category | Count | Highlights |
9191
|----------|-------|------------|
9292
| [Agents](./agents/) | 17 | Architect, Explorer, Security Auditor, Test Writer, Refactorer, and 12 more |
93-
| [Skills](./skills/) | 21 | FastAPI, Svelte 5, Docker, Testing, Debugging, Security, and 15 more |
93+
| [Skills](./skills/) | 34 | FastAPI, Svelte 5, Docker, Testing, Debugging, Security, and 28 more |
9494
| [CLI Tools](./tools/) | 21 | Session search, token tracking, code quality, formatters, and runtimes |
9595
| [Code Intelligence](./code-intelligence/) | 3 | ast-grep, tree-sitter, LSP servers for Python/TS/Go |
9696

docs/src/content/docs/getting-started/first-session.md

Lines changed: 8 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -32,39 +32,11 @@ If something isn't working as expected in a CodeForge session, try `ccraw` to se
3232

3333
## What Happens Automatically
3434

35-
When your session starts, several systems activate behind the scenes to make Claude smarter and safer. You don't need to configure any of this — it just works.
35+
When your session starts, several systems activate behind the scenes. You don't need to configure any of this — it just works.
3636

37-
### System Prompt Loading
38-
39-
The main system prompt gives Claude context about your project, coding standards, and behavioral guidelines. It's loaded from your configuration directory and defines how Claude approaches tasks, what tools to prefer, and how to communicate. The prompt is customizable — see [System Prompts](../customization/system-prompts/) for details.
40-
41-
### Plugin Hook Activation
42-
43-
Plugins register hooks that fire at specific points during your session. These run automatically and silently in the background:
44-
45-
**PreToolUse hooks** run before Claude executes a command or edits a file:
46-
- The **workspace scope guard** blocks writes outside your project directory
47-
- The **dangerous command blocker** catches destructive shell commands (`rm -rf /`, `git push --force`, etc.)
48-
- The **protected files guard** prevents edits to secrets, lock files, and other sensitive files
49-
50-
**PostToolUse hooks** run after a tool completes:
51-
- The **session context** plugin injects git state and TODO information
52-
- The **notify hook** sends a desktop notification when Claude finishes a long task
53-
54-
**Stop hooks** run when Claude finishes a turn:
55-
- The **spec reminder** checks whether code was modified without updating specs
56-
- The **auto code quality** plugin runs formatting and linting checks
57-
- The **commit reminder** nudges you to commit if there are significant uncommitted changes
58-
59-
### Session Context Injection
60-
61-
The session context plugin keeps Claude informed about your working environment. At turn boundaries, it injects:
62-
63-
- **Git state** — current branch, uncommitted changes, recent commits
64-
- **Active TODOs** — extracted from TODO comments in recently modified files
65-
- **Commit reminders** — when there are significant uncommitted changes
66-
67-
This means Claude always knows the state of your repository without you having to explain it.
37+
- **System prompt** — gives Claude context about your project, coding standards, and how to communicate. Customizable via [System Prompts](../customization/system-prompts/).
38+
- **Plugin hooks** — 12 plugins fire automatically at key moments: blocking dangerous commands, guarding workspace scope, injecting git state, running code quality checks, and more. See the [Plugins Overview](../plugins/) for details on each one.
39+
- **Session context** — Claude always knows your current branch, uncommitted changes, recent commits, and active TODOs without you having to explain it.
6840

6941
## What to Try First
7042

@@ -122,53 +94,12 @@ ccusage
12294
claude-dashboard
12395
```
12496

125-
## Working with Agents
126-
127-
CodeForge includes 17 specialized agents. You don't need to know their names — Claude automatically delegates to the right agent based on your request. But understanding what's available helps you make better requests.
128-
129-
Here are some example interactions and which agents handle them:
130-
131-
| Your Request | Agent | What It Does |
132-
|-------------|-------|-------------|
133-
| "Explore this codebase" | Explorer | Systematic codebase navigation |
134-
| "Design the API for user management" | Architect | System design and architecture |
135-
| "Debug why the login fails" | Debug Logs | Log analysis and bug investigation |
136-
| "Refactor this module to reduce duplication" | Refactorer | Safe, incremental code transformations |
137-
| "Write a migration from SQLite to PostgreSQL" | Migrator | Database and framework migrations |
138-
| "Profile the performance of the search endpoint" | Perf Profiler | Performance analysis and optimization |
139-
| "Audit this module for vulnerabilities" | Security Auditor | Security review and recommendations |
140-
| "Write documentation for the API" | Doc Writer | Documentation generation |
141-
142-
Each agent carries domain-specific instructions that guide how Claude approaches the task. For example, the security auditor checks OWASP Top 10 categories, while the test writer respects your project's testing patterns and frameworks.
143-
144-
See [Agents](../features/agents/) for the full list of all 17 agents and their specializations.
145-
146-
## Working with Skills
147-
148-
Skills are domain-specific knowledge packs that Claude draws on when relevant. They're suggested automatically by the skill engine based on what you're working on, or you can invoke them directly with slash commands.
149-
150-
### Frequently Used Skills
151-
152-
| Skill | What It Provides |
153-
|-------|-----------------|
154-
| `/spec-new` | Create a new feature specification |
155-
| `/spec-build` | Implement a feature from its spec (plan, build, review, close) |
156-
| `/spec-check` | Audit spec health across the project |
157-
| `/spec-update` | Update specs to match current implementation |
158-
159-
### Auto-Suggested Skills
160-
161-
You don't always need to invoke skills manually. The skill engine watches what you're working on and suggests relevant skills. For example:
162-
163-
- Working on a FastAPI endpoint? The FastAPI skill is suggested with best practices for route design, dependency injection, and error handling
164-
- Writing Docker configuration? The Docker skill provides patterns for multi-stage builds, security hardening, and compose setups
165-
- Debugging a tricky issue? The debugging skill offers systematic approaches to isolate and fix problems
166-
167-
See [Skills](../features/skills/) for the complete catalog of all 21 available skills.
97+
## Agents and Skills
16898

169-
## Understanding the Status Line
99+
CodeForge includes **17 specialized agents** and **34 skills** that activate automatically based on what you're working on. You don't need to memorize names — just describe what you want, and Claude delegates to the right specialist. The examples in "What to Try First" above show this in action.
170100

171-
If your terminal supports it, CodeForge provides a status line that shows session information at a glance. The `ccstatusline` feature adds session metadata to your terminal prompt, so you always know which session you're in and its current state.
101+
- **[Agents](../features/agents/)** — specialized AI personas for architecture, debugging, testing, security, migrations, and more
102+
- **[Skills](../features/skills/)** — domain-specific knowledge packs (FastAPI, Docker, Svelte, debugging patterns, etc.) that the skill engine suggests automatically or you invoke with slash commands like `/spec-new`
172103

173104
## Tips for Effective Sessions
174105

docs/src/content/docs/getting-started/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar:
55
order: 1
66
---
77

8-
CodeForge is a DevContainer configuration that transforms your development environment into an AI-powered workspace. It bundles 12 plugins, 21 tools, 17 specialized agents, and 21 skills into a single `npx codeforge-dev` install.
8+
CodeForge is a DevContainer configuration that transforms your development environment into an AI-powered workspace. It bundles 12 plugins, 21 tools, 17 specialized agents, and 34 skills into a single `npx codeforge-dev` install.
99

1010
## What is CodeForge?
1111

@@ -75,7 +75,7 @@ Agents are specialized AI personas that Claude delegates to based on your reques
7575

7676
See [Agents](../features/agents/) for the full roster.
7777

78-
### 21 Skills
78+
### 34 Skills
7979

8080
Skills are domain-specific knowledge packs that Claude can draw on. They provide curated best practices, patterns, and workflows for specific technologies and tasks:
8181

docs/src/content/docs/getting-started/installation.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,53 @@ Use `git diff .devcontainer/` after updating to review what changed before commi
206206
- If starts are consistently slow, check Docker resource allocation
207207
- The `postStartCommand` runs on every start to deploy configuration files — this is normal and should complete in a few seconds
208208

209+
### `npx codeforge-dev` fails
210+
211+
**Symptoms:** The installer command errors out before creating `.devcontainer/`.
212+
213+
- **Node.js not installed** — the installer requires Node.js 18+ and npm. Run `node --version` to check; install from [nodejs.org](https://nodejs.org/) if missing
214+
- **Network issues** — npm needs to reach the registry to download the package. Check your connection or try `npm config set registry https://registry.npmjs.org/`
215+
- **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`
216+
217+
### VS Code doesn't show "Reopen in Container"
218+
219+
**Symptoms:** You opened the project in VS Code but never see the DevContainer prompt.
220+
221+
- **Extension not installed** — install `ms-vscode-remote.remote-containers` from the Extensions marketplace, then reload VS Code
222+
- **`.devcontainer/` not at repo root** — VS Code looks for `.devcontainer/` in the workspace root folder. If your project is inside a subfolder, open that subfolder directly
223+
- **VS Code version** — DevContainers requires VS Code 1.85 or later. Check **Help → About** and update if needed
224+
225+
### Docker permission errors (Linux)
226+
227+
**Symptoms:** `docker: permission denied` or `Cannot connect to the Docker daemon` errors.
228+
229+
- Add your user to the `docker` group: `sudo usermod -aG docker $USER`, then log out and back in
230+
- Verify with `docker ps` — it should run without `sudo`
231+
- If using Docker rootless mode, ensure the socket path is set correctly in VS Code settings
232+
233+
### WSL 2 integration issues (Windows)
234+
235+
**Symptoms:** Container fails to start, or Docker commands hang inside WSL.
236+
237+
- Open Docker Desktop → **Settings → Resources → WSL Integration** and enable integration for your WSL distro
238+
- Ensure WSL 2 (not WSL 1) is active: run `wsl -l -v` in PowerShell and check the VERSION column
239+
- Restart Docker Desktop after changing WSL settings
240+
241+
### Port conflicts
242+
243+
**Symptoms:** The claude-dashboard or other tools fail to bind their port.
244+
245+
- CodeForge's session dashboard uses **port 7847** by default. If another service uses that port, change it in `devcontainer.json` under `forwardPorts`
246+
- To find what's using a port: `lsof -i :7847` (macOS/Linux) or `netstat -ano | findstr 7847` (Windows)
247+
248+
### Container rebuilds are slow
249+
250+
**Symptoms:** Rebuilding the container takes as long as the first build.
251+
252+
- **Use "Rebuild Container"** (not "Rebuild Without Cache") for routine rebuilds — Docker reuses cached layers for unchanged steps
253+
- **Prune unused images** to free disk space: `docker system prune -a` removes all unused images (confirm you don't need them first)
254+
- **Check disk space** — Docker needs headroom for layer storage. If your disk is nearly full, builds may fail or slow down significantly
255+
209256
## Next Steps
210257

211258
- [First Session](./first-session/) — start using CodeForge with Claude Code

docs/src/content/docs/reference/changelog.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,12 @@ For minor and patch updates, you can usually just rebuild the container. Check t
5151

5252
**Release date:** 2026-02-24
5353

54+
### Changed
55+
56+
#### Docs
57+
- **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
58+
- **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
59+
5460
### Fixed
5561

5662
#### CI: Release Workflow (v1.14.1)
@@ -67,6 +73,7 @@ For minor and patch updates, you can usually just rebuild the container. Check t
6773

6874
#### Docs
6975
- **Active sidebar item** — increased background opacity from 0.08 to 0.14, added `font-weight: 600` and `color: var(--sl-color-accent-high)` for readable contrast against inactive items
76+
- **Stale skill counts** — 5 pages (First Session, Getting Started index, Features index) referenced "21 skills" instead of the correct total of 34 across all plugins (skill-engine: 21, spec-workflow: 8, ticket-workflow: 4, agent-system: 1)
7077

7178
## v1.14.0
7279

0 commit comments

Comments
 (0)