docs: consolidate and improve documentation structure#97
Merged
Conversation
Add task-oriented sections to help agents work more effectively: - Common Tasks: step-by-step workflows for debugging and development - Constraints: explicit "never do X" rules to prevent common mistakes - Common Issues: error-to-solution lookup table for troubleshooting
enitrat
changed the title
enitrat
force-pushed
the
improve-claude-md-structure
branch
from
5788c3b to
b8c8264
Compare
- Remove scattered docs: AGENTS.md, API_DOCUMENTATION.md, python/CLAUDE.md, python/MAINTAINER_GUIDE.md, python/README.md, python/AGENTS.md, ingesters/README.md - Add docs/ARCHITECTURE.md with system design and diagrams - Add docs/API.md with HTTP endpoint documentation - Simplify README.md to focus on quick start - CLAUDE.md now serves as the single source of truth for agent instructions
enitrat
force-pushed
the
improve-claude-md-structure
branch
from
b8c8264 to
87d6eb3
Compare
enitrat
added a commit
that referenced
this pull request
Jan 3, 2026
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
1 participant
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.
Summary
docs/directorydocs/API.mdfor HTTP endpoint documentationdocs/ARCHITECTURE.mdfor system design and diagramsCLAUDE.mdwith task-oriented sections (Common Tasks, Constraints, Common Issues)README.mdto focus on getting startedContext
Documentation was scattered across multiple locations (
python/CLAUDE.md,python/README.md,ingesters/README.md,AGENTS.md, etc.), making it hard to find and maintain. This PR consolidates everything into a clear structure:CLAUDE.md- Agent instructions (task-oriented, actionable)README.md- Project overview and quick startdocs/API.md- API referencedocs/ARCHITECTURE.md- System designThe CLAUDE.md improvements make it more effective for AI agents by adding:
Test Plan
trunk check --fix)