docs(examples): make gymcoach example runnable end-to-end#47
Open
iliassjabali wants to merge 1 commit intomainfrom
Open
docs(examples): make gymcoach example runnable end-to-end#47iliassjabali wants to merge 1 commit intomainfrom
iliassjabali wants to merge 1 commit intomainfrom
Conversation
Closes #23. The gymcoach example shipped a 280-line agent.yaml with no README, no env-var reference, no services to back its memory/health declarations, and two dangling subagent refs (./agents/observer.yaml and ./agents/reflector.yaml) that did not exist. GitHub browsers clicking examples/ first had no way to know what this was or how to run it. This PR adds: - README.md walking through prerequisites, a one-shell-session quick start (cp .env.example, source env, docker compose up, validate, health, generate), the full file layout, required vs. optional env vars, and links to the migration guide / concept docs. - .env.example covering every $env: and $secret: reference in the manifest with comments on their own lines (inline comments break docker compose's env-file parser). - docker-compose.yml starting Postgres 16 + Redis 7 with healthchecks, matching the existing style of packages/control-plane/docker-compose.yml. - agents/observer.yaml and agents/reflector.yaml as minimal but fully schema-valid sub-agent manifests, so `agentspec health` no longer reports two missing-file failures out of the box. Verified locally: from a clean clone, `cp .env.example .env && docker compose up -d && agentspec validate && agentspec health` completes in 6 seconds and reports the Groq endpoint reachable and both sub-agents resolved. `agentspec audit` still runs and returns the same score.
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.
Closes #23.
Summary
The gymcoach example shipped a 280-line
agent.yamlwith no README, no env-var reference, no services to back its memory/health declarations, and two dangling sub-agent refs (./agents/observer.yamland./agents/reflector.yaml) that did not exist. GitHub browsers clickingexamples/first had no way to know what this was or how to run it.This PR goes a bit beyond issue #23 (which only asked for a README) so the example actually delivers the "2 minutes from clone to running code" promise. Files added:
examples/gymcoach/README.mdexamples/gymcoach/.env.example$env:/$secret:reference in the manifest with comments on their own lines (inline comments break docker compose's env-file parser, and that bit me during verification)examples/gymcoach/docker-compose.ymlpackages/control-plane/docker-compose.ymlexamples/gymcoach/agents/observer.yamlexamples/gymcoach/agents/reflector.yamlNo changes to
agent.yamlitself, no changes totool_implementations.py(the existing file docstring already flags the stubs clearly, and the README now links to it with the same warning).Verification
From a clean worktree, I ran the exact README quick start end-to-end:
Total elapsed: 6 seconds from clean state to passing health report. Sub-agents that previously failed with "manifest not found" now pass.
Also verified:
agentspec validatedocker compose configis clean (no interpolation warnings after moving inline comments off value lines)docker compose down -vleaves no leftover volumesagentspec audit agent.yamlstill runs and returns the same score as before (no regression from the new files)Out of scope (deliberately)
./agent/output tree.agentspec generateis the source of truth for that, and committing its output would defeat the "manifest is the spec" principle inCLAUDE.md.Follow-ups spotted during verification (not in this PR)
memory.longTerm:postgresandmemory.shortTerm:redisreport "connection string not resolved ($env:DATABASE_URL)" from the memory health check even thoughenv:DATABASE_URLchecks pass in the same run. Looks like a second resolver path in the memory check that does not seeprocess.env. Worth a separate issue.service.check.tsexplicitly skips loopback addresses with "loopback address is not probed from service checks", which is the right default but should probably be documented somewhere visible.