Polish docs: reorganize pages and clean up AI filler#350
Merged
chrisguidry merged 1 commit intomainfrom Feb 20, 2026
Merged
Conversation
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>
Documentation build overview
Show files changed (12 files in total): 📝 6 modified | ➕ 4 added | ➖ 2 deleted
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #350 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 99 99
Lines 3098 3098
Branches 27 27
=========================================
Hits 3098 3098
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
and observability.md
behavioral deps (retries, timeouts, progress, concurrency) into
task-behaviors.md
production.md cleanup:
letter handling, scaling considerations, monitoring checklist, Grafana
dashboard, tuning recipes
getting-started)
Consistency pass across all docs:
testing.md
🤖 Generated with Claude Code