docs - #59
Merged
Merged
Conversation
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
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.
Pull Request
Short Summary
Adds
potato_specintegration tests covering allSpecLoadercode paths (parallel workflow, DAG workflow, file loading, accessor None paths) and a newfrom-spec.mddoc page covering the full YAML spec format for agents and workflows. Bumps workspace version from0.19.1to0.20.0.Context
Integration test coverage —
potato_spechad zero integration tests against the mock server. The existing tests incrates/potato_spec/tests/load_spec.rsonly parsed YAML into structs; no test exercised the actual agent/workflow construction pipeline. Eight tests now live incrates/baked_potato/tests/agent/spec_test.rs, covering: single-agent execution, sequential workflow, parallel workflow (the path throughbuild_parallelandLoadedSpec::parallelwas completely untested), DAG workflow viaWorkflow::run(None), missing-model error viaSpecError::WorkflowBuild, file-based loading viafrom_spec_path,SpecError::Iofor a nonexistent path, andNonereturns for all four accessors on an unknown ID.To wire this in,
potato-specwas added as a dependency ofbaked-potato(test-only crate, not published).Documentation —
from-spec.mdcovers the full YAML format: agent fields, memory config, completion criteria, tool registration, callback hooks, and all three workflow types (sequential withpass_output, parallel withmerge_strategy, DAG withtasks/dependencies). Includes a full end-to-end Rust example and aLoadedSpecaccessor reference table. Added to the MkDocs nav under Rust Agents and cross-linked fromoverview.md.crates/baked_potato/Cargo.tomlpotato-specdependencycrates/baked_potato/tests/agent/mod.rsspec_testmodule in alphabetical positioncrates/baked_potato/tests/agent/spec_test.rscrates/baked_potato/tests/agent/fixtures/spec.yamlfrom_spec_pathtestpy-potato/docs/docs/agents/from-spec.mdpy-potato/docs/docs/agents/overview.mdFrom Specrow to component table; bump version to 0.20py-potato/mkdocs.ymlFrom Specnav entryCargo.toml/Cargo.lock/py-potato/pyproject.toml/py-potato/uv.lockIs this a Breaking Change?
No. No public API signatures, config formats, or serialization contracts changed. The version bump is a workspace-level increment; all existing callers of
SpecLoader,LoadedSpec, and the workflow types are unaffected.