docs: add CLAUDE.md for AI coding assistants#657
Merged
Conversation
Document the architecture (Mimir.Worker -> MongoDB -> Mimir GraphQL API), the per-project module map, build/test/run commands, the GraphQL query surface and offset-paging behavior, the MongoDB data model and chain-sync flow, and a "where to look for X" index. Content derived from the current codebase. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
Adds a
CLAUDE.mdat the repository root to help Claude Code / AI coding assistants (and new contributors) get oriented quickly.It documents:
Mimir.Worker→ MongoDB →MimirGraphQL API)docker-compose.yml, and the CI workflowsUseOffsetPaging, nototalCount, default 100 / max 300), and themetadatasync-lag caveatPollerType, handlers, converters)All referenced paths and GraphQL field names were verified against the current
main.🤖 Generated with Claude Code