# Documentation

Guides are grouped by the part of Scribe they describe: native client workflows,
workspaces, the optional web stack, server operations, and implementation references.

## Start here

- [Scribe for Git and Perforce users](/docs/scribe-git-perforce.md)
- [1. Start with a minimal server](/docs/tutorials/01-minimal-server.md)
- [2. Add authentication and repository roles](/docs/tutorials/02-add-auth.md)
- [3. Scale across storage instances with a gateway](/docs/tutorials/03-add-gateway.md)
- [4. Operate the cluster with scribe-ctl](/docs/tutorials/04-use-ctl.md)
- [5. Start the web interface with scribe-ctl and Docker](/docs/tutorials/05-start-web-interface.md)
- [Scribe tutorials](/docs/tutorials.md)
- [Work offline](/docs/tutorials/work-offline.md)
- [Daily work with a game and a shared engine](/docs/tutorials/work-with-mounts.md)

## Native client workflows

- [Client workflows](/docs/client-usage.md)
- [Scribe for macOS](https://github.com/Flying-Rat/scribe/blob/main/apps/macos/README.md) — the native app, what it covers, and what still needs the CLI
- [Scribe for Windows](https://github.com/Flying-Rat/scribe/blob/main/apps/windows/README.md) — the WinUI 3 app, same feature set, x64 and ARM64
- [Branches and conflict resolution](/docs/branches.md)
- [Cherry-pick one change](/docs/cherry-pick.md)
- [Ignore rules and path semantics](/docs/ignore-and-paths.md)
- [JSON output for automation](/docs/json-output.md)
- [Parallel client transfers](/docs/parallel-transfers.md)

## Workspaces and projects

- [Workspace views and profiles](/docs/workspace-views.md)
- [Merge and cherry-pick with a partial working copy](/docs/partial-view-merging.md)
- [Shared repository configuration](/docs/repository-config.md)
- [Versioned repository mounts](/docs/repository-mounts.md)
- [Project orchestration](/docs/project-workflows.md)
- [Workspace and collaboration administration](/docs/workspace-administration.md)

## Web interface

- [Web interface](/docs/web-interface.md)
- [Proposals: review a branch integration](/docs/proposals.md)
- [Flows: automation defined in the repository](/docs/flows.md)
- [Background jobs](/docs/background-jobs.md)

## Set up and maintain

- [Run Scribe: choose a way](/docs/manual.md) — `scribe-ctl`, bare metal, or Docker Compose
- [Local clusters with scribe-ctl](/docs/cluster-usage.md)
- [Run Scribe by hand on bare metal](/docs/manual/bare-metal.md)
- [Run Scribe by hand with Docker Compose](/docs/manual/docker-compose.md)
- [Run the web interface by hand](/docs/manual/web-interface.md)
- [Certificates and credentials](/docs/manual/certificates.md)
- [Upgrade a deployment by hand](/docs/manual/upgrades.md)
- [Production deployment checklist](/docs/production-deployment.md)

## Run your server

- [Server setup and maintenance](/docs/server-usage.md)
- [Shared authentication and repository permissions](/docs/auth.md)
- [Public repositories on authenticated storage](/docs/public-repositories.md)
- [Optional repository gateway](/docs/gateway-usage.md)
- [Operations](/docs/operations.md)
- [Troubleshooting](/docs/troubleshooting.md)
- [Durability, publication, and recovery](/docs/durability-and-recovery.md)
- [Versions, migration, backup, and restore](/docs/migration-backup-restore.md)
- [Verified object repair](/docs/object-repair.md)
- [Online integrity checking](/docs/online-integrity.md)
- [Logging](/docs/logging.md)

## CLI reference

- [`scribe-auth` CLI reference](/docs/reference/cli/scribe-auth.md)
- [`scribe-ctl` CLI reference](/docs/reference/cli/scribe-ctl.md)
- [`scribe-gateway` CLI reference](/docs/reference/cli/scribe-gateway.md)
- [`scribe-runner` CLI reference](/docs/reference/cli/scribe-runner.md)
- [`scribe-server` CLI reference](/docs/reference/cli/scribe-server.md)
- [`scribe` CLI reference](/docs/reference/cli/scribe.md)

## Native architecture and formats

- [Architecture](/docs/architecture.md)
- [On-disk format specification](/docs/on-disk-format.md)
- [Wire format specification: TCP v2 and secured v4](/docs/wire-format.md)
- [Gateway routing ledger v2](/docs/gateway-format.md)
- [Migration framework](/docs/migrations.md)

## Development

- [Dependencies](/docs/dependencies.md)
- [Testing Scribe](/docs/testing.md)
- [Synthetic concurrency benchmark](/docs/concurrency-benchmark.md)