A single entry point for human readers and AI agents walking the docs/ tree.
overview.md— one-page summary for developers, reviewers, and AI agentsconcepts.md— tool-use readiness in depth (the seven dimensions)category.md— what an "agent release gate" is, in product termsglossary.md— category vocabularyai-search-summary.md— human-readable summary for AI search and coding agentsdesign-partners.md— early design partner criteria and contact patharchitecture.md— codebase layout for new contributorsengineering/ai-coding-workflow-verifier.md— canonical engineering guide and roadmap for making Agents Shipgate the deterministic verifier inside AI coding workflowsmanifest-v0.1.md— manifest schema in prose formtrust-model.md— what the scanner does and doesn't dobaseline.md— baseline workflowframework-adapter-checklist.md— checklist for adding static framework adapters
checks.md— full check catalog (human-readable)checks.json— machine-readable check catalog (regenerated each release)manifest-v0.1.json— JSON Schema forshipgate.yamlreport-schema.v0.22.json— JSON Schema forreport.json(current; emitted reports carryreport_schema_version: "0.22", adding the verifier-cycle top-level blockscapability_change,protected_surface_changes,effective_policy,human_ack, andverifier_summaryalongside v0.21'sheuristics_filterenvelope)verifier-schema.v0.1.json— JSON Schema forverifier.jsonemitted byagents-shipgate verifyprivacy.mdandreport-sensitive-fields.json— redaction behavior and report sensitive-field inventoryagent-action-guide.md— per-category recipe for what to do with a finding (canonical fix per check category, last-resort suppression rules)upstream-integrations.md— per-framework 60-second drop-in for adding Shipgate to an existing project (OpenAI Agents SDK, LangChain, CrewAI, ADK, MCP-only, OpenAPI-only, OpenAI Messages API, Anthropic Messages API)report-schema.v0.21.json— frozen v0.21 reference schema; pre-v0.22 reports validate against thisreport-schema.v0.20.json— frozen v0.20 reference schema; pre-v0.21 reports validate against thisreport-schema.v0.19.json— frozen v0.19 reference schema; pre-v0.20 reports validate against thisreport-schema.v0.18.json— frozen v0.18 reference schema; pre-v0.19 reports validate against thisreport-schema.v0.17.json— frozen v0.17 reference schema; pre-v0.18 reports validate against thisreport-schema.v0.16.json— frozen v0.16 reference schema; pre-v0.17 reports validate against thisreport-schema.v0.15.json— frozen v0.15 reference schema; pre-v0.16 reports validate against thisreport-schema.v0.14.json— frozen v0.14 reference schema; pre-v0.15 reports validate against thisreport-schema.v0.13.json— frozen v0.13 reference schema; pre-v0.14 reports validate against thisreport-schema.v0.12.json— frozen v0.12 reference schema; pre-v0.13 reports validate against thisreport-schema.v0.11.json— frozen v0.11 reference schema; pre-v0.12 reports validate against thisreport-schema.v0.10.json— frozen v0.10 reference schema; pre-v0.11 reports validate against thisreport-schema.v0.9.json— frozen v0.9 reference schema; pre-v0.10 reports validate against thisreport-schema.v0.8.json— frozen v0.8 reference schema; pre-v0.9 reports validate against thisreport-schema.v0.7.json— frozen v0.7 reference schema; pre-v0.8 reports validate against thisreport-schema.v0.6.json— frozen v0.6 reference schema; pre-v0.7 reports validate against thispacket-schema.v0.6.json— JSON Schema for the Release Evidence Packet (current; emitted packets carrypacket_schema_version: "0.6", adding the top-levelevidence_matrixsection (PR #104) andReleaseDecisionItem.{source, policy_evidence_source}for reviewer-grade dual-source provenance (PR #103) on top of v0.5)packet-schema.v0.5.json— frozen v0.5 reference packet schema; pre-v0.6 packets validate against thispacket-schema.v0.4.json— frozen v0.4 reference packet schemapacket-schema.v0.3.json— frozen v0.3 reference packet schemacategory.md— what an "agent release gate" is, in product terms
examples.md— narrative tour of sample agents and CI recipes../examples/golden-prs/— end-to-end advisory PR examples for humans and coding agentsmanifest-v0.1.example.minimal.yaml— smallest valid manifestmanifest-v0.1.example.full.yaml— every section populated../samples/— runnable fixtures../samples/_anti_patterns/— manifests that intentionally fail validation
quickstart.md— verify-first AI-generated PR workflowfaq.md— common questions, AI-search-friendlyintegrations.md— CI/CD integration recipes (GitHub Actions, GitLab CI, CircleCI, Jenkins snippet)troubleshooting.md— error messages → fixesdistribution.md— release process and SBOM/signature verificationdecisions.md— architectural decisions
agent-recipes.md— copy-pasteable AI-agent workflows for verify-first PRs and first adoption (detect → init → scan → apply-patches)agent-contract-current.md— current statement of whichreport.jsonfields agents and CI integrations should readreport-reading-for-agents.md— reader's primer forreport.json; walks the file in the order a new consumer should read itagent-autofix-boundary.md— what an agent may do mechanically vs. what must defer to a human reviewerautofix-policy.md— which findings are safe to apply, which need review, and howapply-patches --confidencefilters themdiagnostics.md— ranked next-action diagnostics surfaced bydetect,doctor, and structured-error JSONtarget-repo-agent-snippets.md— copyableAGENTS.md, Codex skill,CLAUDE.md, Cursor, PR template, and advisory workflow snippets for downstream reposagents/use-with-claude-code.md— install the/shipgateslash command andagents-shipgateskill in your agent projectagents/use-with-codex.md— install the canonicalAGENTS.mdsnippet and repo-scoped Codex skillagents/use-with-cursor.md— drop the auto-attach.cursor/rules/agents-shipgate.mdcrule in for Cursoragent-adoption-harness.md— manual protocol for measuring whether coding agents discover and use Shipgateminimal-real-configs.md— framework-by-framework references to the smallest working manifest../AGENTS.md— agent-facing instructions../CLAUDE.md— Claude Code-specific notes../STABILITY.md— what won't break across0.x../prompts/— reusable prompts../llms.txt— AI-readable project summaryai-search-summary.md— prose companion tollms.txt../.well-known/agents-shipgate.json— discovery metadata