The root README is the short product introduction. Use this map when you need the operating contract or policy details behind it.
From a managed repository, the installed CLI reads the documentation carried by that repository's locked release:
code-polishy docs list
code-polishy docs find behavior review
code-polishy docs read agent-workflows
code-polishy docs read adding-a-languageThe checked-in catalog.json owns stable topic identifiers, titles, summaries,
and aliases. Search is local, bounded, and deterministic.
- Installation explains exact-tag source installation, portable archives, OCI execution, manifests, and target locks.
- AI-Agent Setup and Adoption is the authoritative procedural runbook for setup and upgrades performed by a coding agent.
- Adopting Code Polishy is the detailed project-modeling reference for modules, capabilities, checks, tests, and CI.
- Agent Workflows covers ordinary interactive work, native subagents, and optional task sessions.
- Isolated Task Sessions specifies disposable-worktree boundaries, promotion, and artifacts.
- Artifact Security documents shared container scanning, producer contracts, OpenVEX, and optional behavior-review evidence custody.
- Architecture
- Behavior and final-state review, including experimental opt-in feature policy and task requests
- Code quality
- Conditional modules
- Exceptions
- Portability and external inputs
- Security
- Supply chain
- Test strength
- Verification and testing
- Canonical Agent Guidance Design defines what
belongs in managed
AGENTS.md, where longer rationale lives, and how to update the template. - Policy Engine Architecture maps the runtime ownership boundaries and execution model.
- Source Comment Policy Design explains the default-preserving switch and the rationale for repositories that select the strict no-comment boundary.
- Source Provenance records public design references, toolchain origins, and implementation boundaries.
- Release Checklist defines immutable tags, native publications, and digest-pinned OCI releases.
- Adding a Language Pack defines local language packs, conformance verification, exact installation, and adapter protocol.