Add AGENTS.md and trim the README - #180
Open
FWao wants to merge 2 commits into
Open
Conversation
JonasRichartz
approved these changes
Aug 20, 2026
Documents the pipeline stages, repository layout, build and test commands, the dependency-pinning rules enforced by scripts/check_dependency_config.py, code conventions (beartype, jaxtyping, trailing-underscore side effects, deferred imports) and the branch/PR workflow. CLAUDE.md just points at it.
Removes the "Why uv is required" section and condenses the platform notes, pre-built-wheel paragraph and troubleshooting prose. The reasoning behind the dependency configuration lives in AGENTS.md and in the pyproject comments; the README keeps the actionable parts.
FWao
changed the title
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.
Adds an
AGENTS.mddescribing how to work in this repository, plus aCLAUDE.mdthat points at it.Covers the branch/PR workflow, repository layout, build and test commands, the dependency-pinning rules enforced by
scripts/check_dependency_config.py, code conventions (beartype, jaxtyping, trailing-underscore side effects), how to add an extractor/encoder/model, and a handful of gotchas.Also trims the installation rationale that #179 added to the README (-44 lines): drops the "Why uv is required" section and condenses the platform notes, pre-built-wheel paragraph and troubleshooting prose. That reasoning now lives in
AGENTS.mdand thepyproject.tomlcomments; the README keeps the actionable parts.Documentation only — no code or dependency changes.