# Tunnel Client Documentation

This folder contains customer-facing operator documentation and contributor
documentation for `tunnel-client`.

## Start here

- **Shareable end-user guide**: [`end-user-guide.md`](end-user-guide.md)
- **Onboarding (recommended first read)**: [`onboarding.md`](onboarding.md)
- **Permissions, roles, and groups**: [`permissions.md`](permissions.md)
- **Architecture diagrams**: [`architecture.md`](architecture.md)
- **Connector behavior**: [`connectors.md`](connectors.md)
- **Enterprise customer handoff**: [`enterprise-customer-onboarding.md`](enterprise-customer-onboarding.md)

## Operator docs

- **Configuration reference**: [`configuration.md`](configuration.md)
- **Deployments**: [`deployment/overview.md`](deployment/overview.md)
- **Troubleshooting**: [`troubleshooting.md`](troubleshooting.md)
- **Connector behavior and pitfalls**: [`connectors.md`](connectors.md)

## Maintainer / contributor docs

- **Guide theme and visual manifest**: [`pdf/`](pdf)
- **Guide HTML archive command**: `make end-user-guide-html`
- **Guide slide deck command**: `make end-user-guide-slides`
- **Guide screenshot refresh command**: `make end-user-guide-screenshots`
- **Development & testing**: [`development.md`](development.md)
- **Roadmap / design notes**: [`roadmap.md`](roadmap.md)
