docs: consolidate agent instructions into canonical AGENTS.md#346
Merged
Conversation
Merge the parallel CLAUDE.md/AGENTS.md into one agent-agnostic AGENTS.md (uniform skeleton) and reduce CLAUDE.md to an @AGENTS.md import stub. Move the long decorator-internals + JAX-boundary + xp-threading material into docs/agents/jax_and_decorators.md (the single ecosystem deep dive). Fix drift: autoarray types ARE JAX pytrees (_register_as_pytree / register_instance_pytree) — replace the stale 'not pytrees / cannot return from jit' wording with the two JIT-boundary patterns; use aa.decorators.* (grid_dec is a deprecated alias). State CI (3.12 + 3.13, black advisory), requires-python >=3.9, and add a short run-verified README. Co-Authored-By: Claude Opus 4.8 (1M context) <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
Consolidates the two parallel, drifting agent-docs (
CLAUDE.mdread by Claude Code,AGENTS.mdread by Codex) into one canonical, agent-agnosticAGENTS.md.CLAUDE.mdbecomes a 4-line@AGENTS.mdimport stub, so every agent reads identical instructions.Part of a 5-repo sweep (PyAutoConf/Fit/Array/Galaxy/Lens) on branch
claude/zealous-gates-l5vxfg; all five AGENTS.md share an identical heading order and skeleton.Uniform skeleton
What this repo is→Related repos→Quick commands→CI / definition of green→Configuration & defaults* →JAX & xp* →Public API→Key rules / footguns→Working on issues→Deep dives* →Clean state(*omitted where genuinely N/A, never reordered).Drift fixed (verified against installed source)
_register_as_pytree/register_instance_pytreeexist — replaced the stale "autoarray types are not pytrees / can't return fromjax.jit" claim with the two correct JIT-boundary patterns.operate/has onlyOperateImage(image.py) andLensCalc(lens_calc.py). All references corrected.aa.grid_decis a deprecated alias; shipped profiles useaa.decorators.*.pytest --covon Python 3.12 and 3.13, black advisory (not gated).requires-pythonis>=3.9./mnt/c/__pycache__narrative, namespace tables (→__init__.py), Plot Output Mode, and dependency version-pin lists.This repo: hosts the single ecosystem deep dive
docs/agents/jax_and_decorators.md(decorator internals + JAX boundary + xp threading, moved out of the AGENTS files). Added a short, run-verified README.🤖 Generated with Claude Code