docs: chapter for agents (#682) - #683
Merged
Merged
Conversation
Give coding agents a discoverable guide (AGENTS.md pointer + getting-started chapter) and a maintenance rule so public API changes keep those docs current (#682). Co-authored-by: Cursor <cursoragent@cursor.com>
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
jepegit
enabled auto-merge (squash)
July 25, 2026 09:33
jepegit
disabled auto-merge
July 25, 2026 09:36
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/getting_started/agents.md— example-heavy guide for coding agents using cellpy as a library (researcher GUI/app persona).AGENTS.md(after the managed issue-flow block) and the getting-started index.this-project.mdso public get/schema/CLI changes update the agent docs in the same PR.Closes #682
Test plan
uv run pytest -m essential(preflight)docs/getting_started/agents.mdandAGENTS.mdpointer for accuracy against v2 APIsMade with Cursor