Fix stale AI-facing docs: AGENTS.md v2 API, version drift, file casing#267
Merged
Conversation
AGENTS.md was teaching a v1-style API that no longer exists: the AtomicAgent(system_prompt=..., input_schema=...) constructor, a context_providers list kwarg, and imports from atomic_agents.base. Any coding agent reading the repo got a constructor signature that won't run. Examples rewritten to the real v2 API (AgentConfig, AtomicAgent[In, Out] generics, Instructor-wrapped client, register_context_provider) and verified against the installed framework. Stale component list (lib/, memory/, prompting/, services/) replaced with the actual package layout, hardcoded version removed. The file was also tracked as lowercase agents.md, so @AGENTS.md in CLAUDE.md and tools probing for AGENTS.md missed it on case-sensitive checkouts. Renamed in the index. docs/conf.py now reads the version from the root pyproject.toml directly (was hardcoded at 2.0.4, actual 2.9.1), which retires scripts/sync_version.py and its CI step. Plugin CHANGELOG gains the missing 2.1.0 entry (create-* skills, reviewer model-name fix) plus an Unreleased section for the rebrand, MiniMax M3 default, and the Copilot CLI argument-hint fix. Also drops a duplicated Star History heading in README. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ash manifest 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.
What
First slice of the AI developer experience upgrade. Fixes the artifacts that AI assistants read first, which were actively wrong.
AGENTS.md taught an API that doesn't exist. The Quick Start used
AtomicAgent(system_prompt=..., input_schema=..., output_schema=..., model=...), v1-style constructor kwargs gone since 2.0. Same story for the context-provider example and theatomic_agents.baseimports. Every coding agent that opened this repo learned a constructor that won't run. Rewritten to the real v2 API (AgentConfig,AtomicAgent[In, Out]generics, Instructor-wrapped client,register_context_provider), both examples verified against the installed framework. The component list now matches the actual package layout (lib/,memory/,prompting/,services/don't exist).The file was tracked as lowercase
agents.md. Windows hid it locally, but on case-sensitive checkouts the@AGENTS.mdimport in CLAUDE.md and any tool probing forAGENTS.md(Codex, Cursor, Jules, etc.) missed the file entirely. Renamed in the index.Version drift, fixed structurally.
docs/conf.pywas hardcoded at 2.0.4 (actual: 2.9.1). It now reads the rootpyproject.tomldirectly, soscripts/sync_version.pyand its CI step are retired instead of patched.Plugin changelog gap.
plugin.jsonsays 2.1.0 but the changelog stopped at 2.0.1. Added the 2.1.0 entry (create-* skills, reviewer fix) plus an Unreleased section for the rebrand, MiniMax M3 default, and the Copilot CLI argument-hint fix.Also drops a duplicated
## Star Historyheading from a recent README commit.Verified
conf.pyresolves 2.9.1 standalone (caught and fixed a relative-path bug in the process:Path(__file__)needs.resolve()under some invocations)git ls-filesnow showsAGENTS.mduppercase🤖 Generated with Claude Code