# Documentation

Choose a journey, then use guides for tasks and reference for exact contracts. These pages cover the current repository checkout; [project status](../project-status.md) distinguishes shipped workflows from experimental demonstrations and future work.

## Use SnagBadger

1. [Choose a supported path](getting-started/overview.md) and establish prerequisites.
   Use [guided setup](getting-started/guided-setup.md) for discovery and an approved reporting/testing integration plan.
2. [Create a first portable bug report](getting-started/first-bug-report.md), or [run a first Markdown test](getting-started/first-test-run.md) with your own runtime.
3. [Review results and promote problems](guides/review-results-and-create-bug-reports.md).
4. [Review and sanitize evidence before export](guides/export-and-sanitize-evidence.md).

Start with the [sample site](../examples/sample-site.md) when you need a disposable behavior to explore.

## Understand the model

- [Reports and evidence](concepts/reports-and-evidence.md): authored steps, actual interactions, revisions and reproduction readiness.
- [Plans and sections](concepts/test-plans-and-sections.md): reusable definitions, inheritance and execution revisions.
- [Runs, results and attempts](concepts/runs-results-and-attempts.md): retained history, independent comments and aggregation.

## Find an exact contract

Use [public APIs](reference/public-api.md), [configuration](reference/configuration.md), [catalog format](reference/test-definition-format.md), [runner commands](reference/runner-commands.md), [skills/runtime requirements](reference/agent-skills-and-runtime-requirements.md), and [serialized formats](reference/report-and-bundle-formats.md).

## Contribute or work as a coding agent

[Setup and first change](contributing/setup-and-first-change.md) introduces the pinned toolchain and complete gate. Continue with [architecture](contributing/architecture-and-module-boundaries.md), [quality checks](contributing/testing-and-quality-checks.md), and [worktrees/browser evidence](contributing/worktrees-and-browser-verification.md).

Repository-agent verification is different from running the product's agent-testing workflow. Read the correct prerequisites for each. [Documentation maintenance](contributing/documentation-and-example-maintenance.md) explains how to keep this site aligned with code.