docs: Align documentation with create_version() deploy pattern#1
Merged
Conversation
Three docs referenced a delete+recreate deployment pattern, but deploy_agent.py actually uses agents.create_version() which creates the agent if new or adds a versioned snapshot if it already exists. Updated docs/how-it-works.md, docs-site/architecture.md, and docs-site/concepts/mental-model.md to reflect the actual behavior. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
ericchansen
changed the title
Address code review feedback: several docs and the source docstring still referenced agents.create() or 'recreate fresh' language after the initial fix. Updated faq.md, index.md, agent-definition.md, mental-model.md, and agent_definition.py to consistently use create_version() terminology throughout. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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
Three documentation files described a "delete + recreate" agent deployment pattern, but the code actually uses
agents.create_version()which creates the agent if new or adds a versioned snapshot if it already exists. This PR aligns the docs with the actual implementation.Changes
docs/how-it-works.mdcreate_version()instead of delete+recreatedocs-site/architecture.mddocs-site/concepts/mental-model.mdVerification
ruff check .)deploy_agent.pyusesagents.create_version()(line 141)