Skip to content

Commit a4af226

Browse files
chrisguidryclaude
andcommitted
Polish docs: reorganize pages and clean up AI filler
The docs had grown into a couple of monolith pages (advanced-patterns.md at 1100 lines, dependencies.md at 540 lines) and production.md was padded with generic ops advice (capacity planning formulas, blue-green deployment instructions, Grafana dashboards) that doesn't belong in project docs. Reorganization: - Split advanced-patterns.md into task-behaviors.md, task-patterns.md, and observability.md - Split dependencies.md into dependency-injection.md and moved behavioral deps (retries, timeouts, progress, concurrency) into task-behaviors.md - Updated nav, mkdocs.yml, and cross-references accordingly production.md cleanup: - Cut Redis Streams Architecture internals (creates implied contracts) - Cut generic sections: capacity planning, deployment strategies, dead letter handling, scaling considerations, monitoring checklist, Grafana dashboard, tuning recipes - Moved CLI strike examples into the Striking section - Added Signal Handling section for k8s/container orchestrator users - Removed Error Handling section (already covered in task-behaviors and getting-started) Consistency pass across all docs: - Removed closing filler paragraphs from task-behaviors.md and testing.md - Fixed "comprehensive" wording in getting-started.md and testing.md - Updated stale production.md description in getting-started.md nav Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 23e3c3d commit a4af226

16 files changed

+1544
-1867
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
cache-dependency-glob: "pyproject.toml"
3333

3434
- name: Install dependencies
35-
run: uv sync --group docs
35+
run: uv sync
3636

3737
- name: Build documentation
3838
run: uv run zensical build

.readthedocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ build:
55
python: "3.12"
66
commands:
77
- pip install uv
8-
- uv sync --group docs
8+
- uv sync
99
- uv run zensical build
1010
- mkdir -p $READTHEDOCS_OUTPUT/html
1111
- cp -r site/* $READTHEDOCS_OUTPUT/html/

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ time.
124124
To work on the documentation locally:
125125

126126
```bash
127-
uv sync --group docs
127+
uv sync
128128
uv run zensical serve
129129
```
130130

0 commit comments

Comments
 (0)