re #15 docs: add AgentSpec package guide#53
Merged
Conversation
Adds docs/packages/agent-spec.md following the per-package template established for the framework's documentation set, and slots it into the index under a new "Tooling" group. The guide covers: what AgentSpec is and why it exists, install and quick start, the four-role pipeline (Scanner / Generator / Renderer / Writer), the CLI surface (manifest:generate, manifest:show, --check), sidecars (purpose.md, patterns.md, stability.md), the application manifest stub, container-based pipeline overrides, testing notes, extension points (renderer + scanner contracts), recipes, and limitations.
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/packages/agent-spec.md— the user-facing guide foruniveros/agent-spec(the package merged via re #18 add univeros/agent-spec — AI-readable package manifests #52, closing univeros/agent-spec — AI-readable manifests for every package #18). The guide follows the per-page template established by the other 16 package docs.docs/README.mdto slot AgentSpec under a new Tooling section and softens the hard-coded "16 sub-packages" count so future additions don't drift the preamble.The page is prose-driven with second-person voice, runnable code examples, and covers:
bin/altair manifest:generate,manifest:show,--check).agent/purpose.md,patterns.md,stability.md), CI integration, application manifest stubConfigurationclass — wired via the CLI auto-discovery path inbin/altair)tests/AgentSpec/Snapshots/)Contracts/interfaces)patterns.mdNo PHP source touched.
composer csruns cleanly (no files to fix).Test plan
docs/packages/agent-spec.mdrenders cleanly on github.com (tables, fenced code, links)./cli.mdwill 404 until cli docs land — flagged but intentional)docs/README.mdindex still groups all existing packages correctlycomposer cspasses)