Skip to content

Commit dee1161

Browse files
authored
Merge pull request #3 from gerred/release/agentic-systems-series
Release Agentic Systems Series: Claude Code & Amp Architecture Patterns
2 parents a8f6bbf + 2894522 commit dee1161

File tree

83 files changed

+16640
-12562
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+16640
-12562
lines changed

.github/workflows/mdbook.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,27 @@ concurrency:
2525
cancel-in-progress: false
2626

2727
jobs:
28+
# Link check job
29+
linkcheck:
30+
runs-on: ubuntu-latest
31+
env:
32+
MDBOOK_VERSION: 0.4.36
33+
steps:
34+
- uses: actions/checkout@v4
35+
- name: Install mdBook
36+
run: |
37+
curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
38+
rustup update
39+
cargo install --version ${MDBOOK_VERSION} mdbook
40+
cargo install mdbook-mermaid
41+
cargo install mdbook-linkcheck
42+
- name: Check links
43+
run: mdbook build
44+
2845
# Build job
2946
build:
3047
runs-on: ubuntu-latest
48+
needs: linkcheck
3149
env:
3250
MDBOOK_VERSION: 0.4.36
3351
steps:
@@ -38,6 +56,7 @@ jobs:
3856
rustup update
3957
cargo install --version ${MDBOOK_VERSION} mdbook
4058
cargo install mdbook-mermaid
59+
cargo install mdbook-linkcheck
4160
- name: Setup Pages
4261
id: pages
4362
uses: actions/configure-pages@v5

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
book
2+
.mcp.json
3+
anon-kode

AGENT.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# AGENT.md - Build Configuration for Agentic Systems Series
2+
3+
## Project Type
4+
This is an mdBook documentation project for "The Agentic Systems Series" - a comprehensive guide to building AI coding assistants.
5+
6+
## Build Commands
7+
- **Build**: `mdbook build` - Generate static site in `./book` directory (includes link checking)
8+
- **Serve**: `mdbook serve` - Start local development server on http://localhost:3000
9+
- **Clean**: `mdbook clean` - Remove generated files
10+
- **Test**: `mdbook test` - Test code blocks in documentation
11+
- **Link Check**: Built into `mdbook build` - Automatically checks for broken internal links
12+
13+
## Repository Structure
14+
- `src/` - Markdown source files for the book
15+
- `book.toml` - mdBook configuration
16+
- `book/` - Generated static site (after build)
17+
- Custom JS/CSS: `mermaid.min.js`, `mermaid-init.js`, `custom.css`
18+
19+
## Content Guidelines
20+
- Use clear, technical writing focused on practical engineering patterns
21+
- Include code examples and architectural diagrams using Mermaid
22+
- Maintain consistent structure with numbered chapters and clear sections
23+
- Focus on real-world implementations over theoretical concepts
24+
- Target software engineers building AI-powered development tools
25+
26+
## Dependencies
27+
- mdBook 0.4.36+ with mdbook-mermaid preprocessor for diagrams
28+
- GitHub Pages deployment via workflow in `.github/workflows/mdbook.yml`

CLAUDE.md

Lines changed: 55 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,41 @@
1-
# Claude Code Deep Dive - mdbook Guidelines
1+
# CLAUDE.md
22

3-
This repository contains documentation about Claude Code's architecture being structured as a book using mdbook or similar tool.
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
44

5-
## Documentation Structure
6-
- Content organized in chapters and sections for logical reading flow
7-
- Maintain consistent hierarchy with clear parent-child relationships
8-
- Use SUMMARY.md for book navigation structure
5+
## Project Overview
96

10-
## Formatting Guidelines
11-
- Follow standard Markdown formatting for code blocks, lists, and emphasis
12-
- Use relative links for cross-references between book sections
13-
- Include mermaid diagrams for visual explanations
14-
- Use descriptive filenames with hyphens instead of spaces
15-
- Maintain consistent heading structure (#, ##, ###)
7+
This is an mdBook documentation project - "The Agentic Systems Series" - a comprehensive two-book guide about building AI coding assistants. It analyzes architecture patterns from Claude Code, anon-kode, and Amp to provide practical insights for engineers building production AI development tools.
168

17-
## Navigation
18-
- Ensure chapters flow logically from introduction to advanced topics
19-
- Include navigation links at bottom of pages where appropriate
20-
- Maintain table of contents for easy reference
9+
The series covers everything from single-user local tools (Book 1) to collaborative enterprise platforms (Book 2).
2110

22-
## Writing Style
11+
## Common Commands
12+
13+
```bash
14+
# Local development
15+
mdbook serve # Start local server at http://localhost:3000
16+
mdbook build # Build static site to book/ directory
17+
mdbook clean # Clean build artifacts
18+
19+
# Testing
20+
mdbook test # Test code examples in documentation
21+
```
22+
23+
## Project Structure
24+
25+
The documentation follows mdBook conventions:
26+
- `src/` - All markdown content files
27+
- `src/SUMMARY.md` - Navigation structure and chapter ordering
28+
- `book.toml` - mdBook configuration
29+
- `amp/` - Contains analyzed source code from amp/Claude Code
30+
- `src/second-edition/` - Book 2: Amping Up an Agentic System
31+
32+
Key content areas:
33+
- **Book 1**: Core architecture patterns (reactive UI, streaming, permissions), tool systems, command systems
34+
- **Book 2**: Collaborative architecture, enterprise features, scaling patterns, production deployment
35+
36+
## Writing Guidelines
37+
38+
### Style
2339
- Technical but relaxed: Clear explanations without formal language, avoiding buzzwords or unnecessary complexity
2440
- Concise and direct: Minimal filler or extra detail; each sentence contributes meaningfully
2541
- Casual yet authoritative: Written as a peer talking to other engineers—approachable but clearly knowledgeable
@@ -28,10 +44,30 @@ This repository contains documentation about Claude Code's architecture being st
2844
- IRC-inspired pragmatism: Direct and practical, straightforward phrasing reminiscent of a developer chat rather than corporate communication
2945
- Varied article usage: Diverse use of articles ("a", "the", "this", etc.) rather than repetitive patterns
3046

31-
## Hard Rules
47+
### Hard Rules
3248
- **NO speculation**: Only document what's observable in the code. Never speculate about intentions, roadmaps, or development status.
3349
- **NO prescriptive language**: Avoid "should", "must", "need to", "have to" when giving recommendations. Use "consider" or simply state options directly.
3450
- **NO obvious details**: Skip mentioning basic implementation details like UTF-8 encoding or standard language features that any developer would expect.
3551
- **NO LLM-like language**: Avoid flowery or overly formal descriptions. Write like a programmer talking to another programmer.
3652
- **NO weasel words**: Avoid hedging language like "perhaps", "seems to", "appears to", "might be", "this approach", "this pattern", "this system", unless truly uncertain. Be direct and assertive.
37-
- **Facts only**: Base all technical documentation on direct code evidence, not assumptions.
53+
- **Facts only**: Base all technical documentation on direct code evidence, not assumptions.
54+
55+
## Architecture Notes
56+
57+
The series analyzes real implementations from multiple systems:
58+
59+
**Book 1 (Claude Code/anon-kode patterns):**
60+
- Reactive UI built with Ink and Yoga for terminal interfaces
61+
- Parallel tool execution for performance
62+
- Permission system for safe operations
63+
- Extensible tool architecture with standardized interfaces
64+
- Command system with slash commands and contextual help
65+
66+
**Book 2 (Amp collaborative patterns):**
67+
- Conversation management and state synchronization
68+
- Enterprise authentication and identity management
69+
- Real-time collaboration and team workflows
70+
- Multi-agent orchestration and performance optimization
71+
- Production deployment and scaling strategies
72+
73+
When documenting architecture patterns, reference actual source files in `amp/core/src/` for concrete examples, but generalize proprietary implementation details into reusable patterns.

README.md

Lines changed: 23 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,38 @@
1-
# Building an Agentic System
1+
# The Agentic Systems Series
22

3-
A deep-dive guide into architecture patterns for building responsive, reliable AI coding agents.
3+
A comprehensive guide to building production-ready AI coding assistants, from local tools to enterprise platforms.
44

5-
## About This Book
5+
## Overview
66

7-
This guide explores practical architecture patterns for real-time AI coding assistants, derived from an analysis of Claude Code, anon-kode, and other systems. It focuses on:
7+
This two-book series provides practical engineering patterns for building AI coding assistants based on analysis of real production systems including Claude Code, Amp, and open-source implementations.
88

9-
- Responsive user interfaces with streaming responses
10-
- Parallel tool execution for performance
11-
- Permission systems for safety
12-
- Extensible tool architecture
9+
**Book 1: Building an Agentic System**
10+
- Core architecture patterns for AI coding assistants
11+
- Reactive terminal UIs with streaming responses
12+
- Tool systems and permission models
13+
- Parallel execution strategies
1314

14-
Written for software engineers building their own AI agents who want practical architecture patterns rather than theoretical discussions.
15+
**Book 2: Amping Up an Agentic System**
16+
- Scaling from single-user to collaborative platforms
17+
- Enterprise authentication and team workflows
18+
- Real-time synchronization patterns
19+
- Production deployment strategies
20+
21+
## For Engineers
22+
23+
Written for software engineers building AI-powered development tools, with focus on:
24+
- Practical patterns over theory
25+
- Real architectural decisions
26+
- Production-ready implementations
27+
- Scalable system design
1528

1629
## Read Online
1730

1831
Visit [gerred.github.io/building-an-agentic-system](https://gerred.github.io/building-an-agentic-system) for the rendered book.
1932

2033
## Author
2134

22-
<table>
23-
<tr>
24-
<td align="center">
25-
<a href="https://github.com/gerred">
26-
<img src="https://github.com/gerred.png" width="100px;" alt="Gerred Dillon"/>
27-
<br />
28-
<sub><b>Gerred Dillon</b></sub>
29-
</a>
30-
<br />
31-
32-
<br />
33-
<a href="https://x.com/devgerred">@devgerred</a>
34-
</td>
35-
</tr>
36-
</table>
37-
38-
## Contributors
39-
40-
<table>
41-
<tr>
42-
<td align="center">
43-
<a href="https://github.com/gphorvath">
44-
<img src="https://github.com/gphorvath.png" width="100px;" alt="Gregory Horvath"/>
45-
<br />
46-
<sub><b>Gregory Horvath</b></sub>
47-
</a>
48-
<br />
49-
50-
</td>
51-
</tr>
52-
</table>
35+
[Gerred Dillon](https://github.com/gerred) - [[email protected]](mailto:[email protected]) - [@devgerred](https://x.com/devgerred)
5336

5437
## License
5538

book.toml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ authors = ["Gerred Dillon"]
33
language = "en"
44
multilingual = false
55
src = "src"
6-
title = "Building an Agentic System"
6+
title = "The Agentic Systems Series"
77

88
[output.html]
99
mathjax-support = true
@@ -14,3 +14,10 @@ additional-css = ["custom.css"]
1414

1515
[preprocessor.mermaid]
1616
command = "mdbook-mermaid"
17+
18+
[output.linkcheck]
19+
# Check for broken links in the book
20+
follow-web-links = false
21+
exclude = ["^https://github.com/.*/pull/.*", "^https://github.com/.*/issues/.*"]
22+
# Enable more thorough checking
23+
warning-policy = "error"

0 commit comments

Comments
 (0)