Skip to content

Commit a421b80

Browse files
committed
Add Why CodeForge, Architecture, and Configuration sections to README
Adds three sections identified as gaps in the repo quality audit: - "Why CodeForge?" — motivation and origins as a power user's setup - Architecture overview with three-layer diagram - Configuration summary table with link to docs site
1 parent 356f7ed commit a421b80

File tree

2 files changed

+54
-0
lines changed

2 files changed

+54
-0
lines changed

.devcontainer/CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
### Added
66

7+
#### README
8+
- **"Why CodeForge?" section** — motivation and value proposition explaining the project's origins as a power user's personal setup
9+
- **Architecture overview** — three-layer diagram (DevContainer → CodeForge Layer → Claude Code) with brief descriptions and link to full architecture docs
10+
- **Configuration summary** — table of key config files with links to the documentation site
11+
712
#### Docs
813
- **CLAUDE.md** — new "Status Bar Widgets" section documenting widget properties, token color conventions, label fusion pattern, and available widget types
914

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@
1010

1111
A curated development environment optimized for AI-powered coding with Claude Code. CodeForge comes pre-configured with language servers, code intelligence tools, and official Anthropic plugins to streamline your development workflow.
1212

13+
## Why CodeForge?
14+
15+
Claude Code is powerful out of the box, but getting the most from it takes significant configuration — custom agents, safety plugins, code quality hooks, system prompts, and development tools that aren't obvious from the docs. CodeForge is a Claude Code power user's personal development environment, packaged so anyone can use it.
16+
17+
Instead of spending hours discovering and configuring advanced features like built-in agent replacement, automated code quality pipelines, or spec-driven workflows, you get a production-tested setup in one command. It's opinionated by design — every default reflects real daily use, not theoretical best practices.
18+
1319
## Installation
1420

1521
Add CodeForge to any project:
@@ -74,6 +80,49 @@ tmux, agent-browser, claude-monitor, ccusage, ccburn, ccstatusline, ast-grep, tr
7480

7581
The `agent-system` plugin includes 17 specialized agents (architect, explorer, test-writer, security-auditor, etc.). The `skill-engine` plugin provides 22 general coding skills, `spec-workflow` adds 8 spec lifecycle skills, and `ticket-workflow` provides 4 ticket management skills.
7682

83+
## Architecture
84+
85+
CodeForge operates in three layers, each building on the one below:
86+
87+
```
88+
┌──────────────────────────────────────────────┐
89+
│ Claude Code │
90+
│ AI assistant, tool execution, Agent Teams │
91+
├──────────────────────────────────────────────┤
92+
│ CodeForge Layer │
93+
│ Plugins · Agents · Skills · Hooks · Rules │
94+
├──────────────────────────────────────────────┤
95+
│ DevContainer │
96+
│ Runtimes · CLI Tools · LSP Servers │
97+
└──────────────────────────────────────────────┘
98+
```
99+
100+
**DevContainer** — The foundation. A Python 3.14 container with Node.js, Rust, and Bun runtimes, plus 22 custom features that install development tools (ast-grep, tree-sitter, biome, ruff, and others).
101+
102+
**CodeForge Layer** — The intelligence. 13 plugins register hooks that validate commands, inject context, and enforce safety. 17 agents provide specialized personas. 35 skills offer on-demand reference material. System prompts and rules shape behavior.
103+
104+
**Claude Code** — The AI assistant, executing tools and coordinating work. CodeForge enhances it through configuration — replacing built-in subagents, adding safety guardrails, and wiring up quality checks that run automatically.
105+
106+
For the full architecture breakdown — hook pipeline, agent routing, skill loading, and design principles — see the [Architecture Reference](https://anexileddev.github.io/CodeForge/reference/architecture/).
107+
108+
## Configuration
109+
110+
All configuration lives in `.devcontainer/` and deploys automatically on container start. Key files:
111+
112+
| File | What It Configures | User-Modifiable? |
113+
|------|--------------------|------------------|
114+
| `config/defaults/settings.json` | Model, plugins, permissions, environment variables | Yes |
115+
| `config/defaults/main-system-prompt.md` | Claude's behavioral guidelines and directives | Yes |
116+
| `config/defaults/keybindings.json` | Keyboard shortcuts | Yes |
117+
| `config/defaults/ccstatusline-settings.json` | Terminal status bar widgets and layout | Yes |
118+
| `config/file-manifest.json` | Which config files deploy and how they update | Yes |
119+
| `devcontainer.json` | Container image, features, runtimes, ports | Yes |
120+
| `.env` | Setup phase toggles (auth, plugins, aliases, etc.) | Yes |
121+
122+
Config files use SHA-256 change detection — your edits persist across container rebuilds unless the source changes. Set a file's overwrite mode to `"never"` in `file-manifest.json` to permanently preserve your customizations.
123+
124+
For the complete configuration guide, see the [documentation site](https://anexileddev.github.io/CodeForge/customization/configuration/).
125+
77126
## Quick Start
78127

79128
1. **Install**: `npx codeforge-dev`

0 commit comments

Comments
 (0)