# Presswork

> Maintain and validate repository documentation for software agents with Presswork.

## Docs

- [Presswork](https://presswork.sh/): Maintain and validate repository documentation for software agents with versioned policy, read-only Checks, and actionable outcomes.
- [Getting Started](https://presswork.sh/getting-started): Install Presswork, run a first Check against a Git repository, recognize each report outcome, and select an explicit Repository Root.
- [Concepts](https://presswork.sh/concepts): Understand how repository boundaries, document discovery, versioned policy, read-only Validation, and Check outcomes fit together.

## Guides

- [Check a Repository](https://presswork.sh/check-a-repository): Run Validation against a discovered or explicit Repository Root, interpret complete and incomplete Check Reports, and follow recovery guidance.
- [Create a Document Draft](https://presswork.sh/create-a-document): List repository Document Types, follow the selected Creation Policy, initialize a Document Draft, and finish it with a clean Check Report.
- [Generate Agent Guidance](https://presswork.sh/generate-agent-guidance): Prepare repository policy, render repository-specific Agent Skill guidance with presswork skills docs, and handle documented failures.

## Product contracts

- [Reference](https://presswork.sh/reference): Choose the exact Presswork contract for configuration, CLI commands, Check Reports, or stable Rule and diagnostic identifiers.
- [Presswork Configuration](https://presswork.sh/configuration): Look up the strict presswork.json contract, Built-in Profiles, paths, Document Types, indexes, and Agent Skill guidance.
- [CLI](https://presswork.sh/cli): Look up all Presswork command families, arguments, options, help forms, output streams, color behavior, diagnostics, and exit status.
- [Check Report](https://presswork.sh/check-report): Look up Check Report completeness, fields, ordering, diagnostics, JSON serialization, streams, exit status, and recovery behavior.
- [Rules and Diagnostics](https://presswork.sh/rules-and-diagnostics): Look up stable Rule identifiers, Check Report Operational Diagnostics, and CLI diagnostic codes grouped by operation family.