refactor(docs): agent-readable zero-to-value onboarding (#1280)#1336
Merged
Conversation
Make the repo's entry points machine-first so an autonomous agent can self-orient and reach a useful result without a human translating context. - AGENTS.md: add a "Using this file" machine-contract header (declares it the authoritative agent entry point, states the AGENTS/CLAUDE/README boundary, explains how to traverse). Rebuild Route-by-task with an explicit "Done when" zero-to-value signal per persona. - CLAUDE.md: cross-link to AGENTS.md and frame CLAUDE.md as the contributor working agreement (auto-loaded by Claude Code), not the agent landing page. - Fixes from a context-free agent onboarding test (AC#5 validation): AGENTS.md deploy verify no longer assumes an undefined $TOKEN (leads with `trinity agents list`, shows token derivation); deploy section states the running-instance prerequisite; README CLI example adds the `trinity agents list` verify step; docs/CLI.md leads with `pip install trinity-cli` (PyPI) and marks `-e src/cli/` as the from-source/dev variant. Validated by an agent performing a zero-to-value deploy task using only repo files, no human context: self-oriented in 2 hops (README -> AGENTS.md) to a correct deploy+verify answer; friction items above are its findings, folded back in. Repo-root AGENTS.md is hand-authored; the CLAUDE.md->AGENTS.md mirror (#1187) is per-agent-container (startup.sh), so these edits are conflict-free. Related to #1280 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Affordance sweep for agent self-selection. Previously an agent had to `ls` config/agent-templates/ (24 dirs, 7 of them test fixtures) and open each template.yaml to find a starting point. - config/agent-templates/README.md: catalog grouping the 17 real templates (single-purpose: scout/sage/scribe/demo-*/trinity-system; the dd-* due- diligence suite) with one-line affordances, how-to-use, and an explicit "not starting points" list for the test/canary fixtures - AGENTS.md: link the catalog from the Deploy-an-agent section so the zero-to-value path is "pick a ready-made template", not "author from scratch" Related to #1280 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Resolve by running |
vybe
approved these changes
Jun 24, 2026
vybe
left a comment
Contributor
There was a problem hiding this comment.
Validated via /validate-pr: docs-only, base=dev, conventional commits, security-clean (no secrets/emails/IPs), enterprise-docs guard passed. Approving.
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.
Summary
Make the repo's canonical entry points machine-first so an autonomous agent landing in the repo (or connecting to an instance) can self-orient and reach a useful result with no human translating context.
Changes
AGENTS/CLAUDE/READMEboundary, explains how to traverse. Rebuilt Route by task with explicit "Done when" zero-to-value signals per persona. Links the new template catalog from the deploy section.trinity agents listverify step to the CLI example.pip install trinity-cli(PyPI); marks-e src/cli/as the from-source/dev variant.dd-*due-diligence suite) with one-line affordances and how-to-use, and explicitly flags the 7 test/canary fixtures as "not starting points". An agent now self-selects a template instead ofls-ing 24 dirs and opening eachtemplate.yaml.Validation (AC#5)
Ran a context-free agent through a real zero-to-value task ("deploy an agent and verify it worked") using only repo files, no human context:
$TOKEN, conflicting CLI install, missing README verify, unstated deploy prerequisite) — folded back in.Acceptance criteria
Notes
CLAUDE.md → AGENTS.mdmirror (Codex harness MVP — pluggable agentic execution engine alongside Claude Code #1187) is per-agent-container (startup.sh), so these repo-root edits are conflict-free..claude/skills affordance pass is deliberately not here: skills live in the privatetrinity-devsubmodule and can't land in a public-repo PR — tracked separately.Related to #1280
🤖 Generated with Claude Code