Skip to content

Commit 32d4787

Browse files
coleam00claude
andcommitted
docs: replace em dashes and move previous version section higher
Replace all em dashes with regular dashes in README. Move the "Previous Version" section to right before Quickstart so existing users find it immediately. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 41067c4 commit 32d4787

1 file changed

Lines changed: 28 additions & 28 deletions

File tree

README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
The first open-source harness builder for AI coding. Make AI coding deterministic and repeatable.
88

9-
Archon is a workflow engine for AI coding agents. Define your development processes as YAML workflows planning, implementation, validation, code review, PR creation and run them reliably across all your projects.
9+
Archon is a workflow engine for AI coding agents. Define your development processes as YAML workflows - planning, implementation, validation, code review, PR creation - and run them reliably across all your projects.
1010

11-
Like what Dockerfiles did for infrastructure and GitHub Actions did for CI/CD Archon does for AI coding workflows. Think n8n, but for software development.
11+
Like what Dockerfiles did for infrastructure and GitHub Actions did for CI/CD - Archon does for AI coding workflows. Think n8n, but for software development.
1212

1313
## Install
1414

@@ -40,11 +40,11 @@ When you ask an AI agent to "fix this bug", what happens depends on the model's
4040

4141
Archon fixes this. Encode your development process as a workflow. The workflow defines the phases, validation gates, and artifacts. The AI fills in the intelligence at each step, but the structure is deterministic and owned by you.
4242

43-
- **Repeatable** Same workflow, same sequence, every time. Plan, implement, validate, review, PR.
44-
- **Isolated** Every workflow run gets its own git worktree. Run 5 fixes in parallel with no conflicts.
45-
- **Fire and forget** Kick off a workflow, go do other work. Come back to a finished PR with review comments.
46-
- **Composable** Mix deterministic nodes (bash scripts, tests, git ops) with AI nodes (planning, code generation, review). The AI only runs where it adds value.
47-
- **Portable** Define workflows once in `.archon/workflows/`, commit them to your repo. They work the same from CLI, Web UI, Slack, Telegram, or GitHub.
43+
- **Repeatable** - Same workflow, same sequence, every time. Plan, implement, validate, review, PR.
44+
- **Isolated** - Every workflow run gets its own git worktree. Run 5 fixes in parallel with no conflicts.
45+
- **Fire and forget** - Kick off a workflow, go do other work. Come back to a finished PR with review comments.
46+
- **Composable** - Mix deterministic nodes (bash scripts, tests, git ops) with AI nodes (planning, code generation, review). The AI only runs where it adds value.
47+
- **Portable** - Define workflows once in `.archon/workflows/`, commit them to your repo. They work the same from CLI, Web UI, Slack, Telegram, or GitHub.
4848

4949
## What It Looks Like
5050

@@ -88,12 +88,16 @@ archon workflow run archon-idea-to-pr --branch feat/dark-mode "Add dark mode to
8888
# → Result: PR ready for human review
8989
```
9090

91+
## Previous Version
92+
93+
Looking for the original Python-based Archon (task management + RAG)? It's fully preserved on the [`archive/v1-task-management-rag`](https://github.com/coleam00/Archon/tree/archive/v1-task-management-rag) branch.
94+
9195
## Quickstart
9296

9397
<details>
94-
<summary><b>Prerequisites</b> Node.js, Claude Code, and the GitHub CLI</summary>
98+
<summary><b>Prerequisites</b> - Node.js, Claude Code, and the GitHub CLI</summary>
9599

96-
**Node.js** (v18+) [nodejs.org](https://nodejs.org/)
100+
**Node.js** (v18+) - [nodejs.org](https://nodejs.org/)
97101

98102
```bash
99103
# macOS/Linux (via nvm, recommended)
@@ -104,7 +108,7 @@ nvm install --lts
104108
winget install OpenJS.NodeJS.LTS
105109
```
106110

107-
**GitHub CLI** [cli.github.com](https://cli.github.com/)
111+
**GitHub CLI** - [cli.github.com](https://cli.github.com/)
108112

109113
```bash
110114
# macOS
@@ -117,7 +121,7 @@ winget install GitHub.cli
117121
sudo apt install gh
118122
```
119123

120-
**Claude Code** [code.claude.com](https://code.claude.com/docs/en/getting-started)
124+
**Claude Code** - [code.claude.com](https://code.claude.com/docs/en/getting-started)
121125

122126
```bash
123127
# macOS/Linux/WSL
@@ -127,7 +131,7 @@ curl -fsSL https://claude.ai/install.sh | bash
127131
irm https://claude.ai/install.ps1 | iex
128132
```
129133

130-
**agent-browser** *(optional)* [vercel-labs/agent-browser](https://github.com/vercel-labs/agent-browser)
134+
**agent-browser** *(optional)* - [vercel-labs/agent-browser](https://github.com/vercel-labs/agent-browser)
131135

132136
Only needed for E2E/UI testing workflows (`archon-validate-pr`). Core functionality works without it.
133137

@@ -183,21 +187,21 @@ The coding agent handles workflow selection, branch naming, and worktree isolati
183187
184188
### Alternative setup paths
185189

186-
- **[Getting Started](https://archon.diy/getting-started/overview/)** Full setup guide (Web UI or CLI)
190+
- **[Getting Started](https://archon.diy/getting-started/overview/)** - Full setup guide (Web UI or CLI)
187191

188192
## Web UI
189193

190194
Archon includes a web dashboard for chatting with your coding agent, running workflows, and monitoring activity. To start it, ask your coding agent to run the frontend from the Archon repo, or run `bun run dev` from the repo root yourself.
191195

192-
Register a project by clicking **+** next to "Project" in the chat sidebar enter a GitHub URL or local path. Then start a conversation, invoke workflows, and watch progress in real time.
196+
Register a project by clicking **+** next to "Project" in the chat sidebar - enter a GitHub URL or local path. Then start a conversation, invoke workflows, and watch progress in real time.
193197

194198
**Key pages:**
195-
- **Chat** Conversation interface with real-time streaming and tool call visualization
196-
- **Dashboard** Mission Control for monitoring running workflows, with filterable history by project, status, and date
197-
- **Workflow Builder** Visual drag-and-drop editor for creating DAG workflows with loop nodes
198-
- **Workflow Execution** Step-by-step progress view for any running or completed workflow
199+
- **Chat** - Conversation interface with real-time streaming and tool call visualization
200+
- **Dashboard** - Mission Control for monitoring running workflows, with filterable history by project, status, and date
201+
- **Workflow Builder** - Visual drag-and-drop editor for creating DAG workflows with loop nodes
202+
- **Workflow Execution** - Step-by-step progress view for any running or completed workflow
199203

200-
**Monitoring hub:** The sidebar shows conversations from **all platforms** not just the web. Workflows kicked off from the CLI, messages from Slack or Telegram, GitHub issue interactions everything appears in one place.
204+
**Monitoring hub:** The sidebar shows conversations from **all platforms** - not just the web. Workflows kicked off from the CLI, messages from Slack or Telegram, GitHub issue interactions - everything appears in one place.
201205

202206
See the [Web UI Guide](https://archon.diy/adapters/web/) for full documentation.
203207

@@ -207,7 +211,7 @@ Archon ships with workflows for common development tasks:
207211

208212
| Workflow | What it does |
209213
|----------|-------------|
210-
| `archon-assist` | General Q&A, debugging, exploration full Claude Code agent with all tools |
214+
| `archon-assist` | General Q&A, debugging, exploration - full Claude Code agent with all tools |
211215
| `archon-fix-github-issue` | Classify issue → investigate/plan → implement → validate → PR → smart review → self-fix |
212216
| `archon-idea-to-pr` | Feature idea → plan → implement → validate → PR → 5 parallel reviews → self-fix |
213217
| `archon-plan-to-pr` | Execute existing plan → implement → validate → PR → review → self-fix |
@@ -220,14 +224,14 @@ Archon ships with workflows for common development tasks:
220224
| `archon-feature-development` | Implement feature from plan → validate → create PR |
221225
| `archon-architect` | Architectural sweep, complexity reduction, codebase health improvement |
222226
| `archon-refactor-safely` | Safe refactoring with type-check hooks and behavior verification |
223-
| `archon-ralph-dag` | PRD implementation loop iterate through stories until done |
227+
| `archon-ralph-dag` | PRD implementation loop - iterate through stories until done |
224228
| `archon-remotion-generate` | Generate or modify Remotion video compositions with AI |
225-
| `archon-test-loop-dag` | Loop node test workflow iterative counter until completion |
229+
| `archon-test-loop-dag` | Loop node test workflow - iterative counter until completion |
226230
| `archon-piv-loop` | Guided Plan-Implement-Validate loop with human review between iterations |
227231

228-
Archon ships 17 default workflows run `archon workflow list` or describe what you want and the router picks the right one.
232+
Archon ships 17 default workflows - run `archon workflow list` or describe what you want and the router picks the right one.
229233

230-
**Or define your own.** Default workflows are great starting points copy one from `.archon/workflows/defaults/` and customize it. Workflows are YAML files in `.archon/workflows/`, commands are markdown files in `.archon/commands/`. Same-named files in your repo override the bundled defaults. Commit them your whole team runs the same process.
234+
**Or define your own.** Default workflows are great starting points - copy one from `.archon/workflows/defaults/` and customize it. Workflows are YAML files in `.archon/workflows/`, commands are markdown files in `.archon/commands/`. Same-named files in your repo override the bundled defaults. Commit them - your whole team runs the same process.
231235

232236
See [Authoring Workflows](https://archon.diy/guides/authoring-workflows/) and [Authoring Commands](https://archon.diy/guides/authoring-commands/).
233237

@@ -298,10 +302,6 @@ Contributions welcome! See the open [issues](https://github.com/coleam00/Archon/
298302

299303
Please read [CONTRIBUTING.md](CONTRIBUTING.md) before submitting a pull request.
300304

301-
## Previous Version
302-
303-
Looking for the original Python-based Archon (task management + RAG)? It's fully preserved on the [`archive/v1-task-management-rag`](https://github.com/coleam00/Archon/tree/archive/v1-task-management-rag) branch.
304-
305305
## License
306306

307307
[MIT](LICENSE)

0 commit comments

Comments
 (0)