GET STARTED
Documentation guidebook
Understand how the Velocity docs are organised and pick the right guide for your role.
Last updated October 8, 2025View on GitHub
Choose your next read
Velocity has a compact library—use this page as your compass. Each guide is tailored to a specific moment in the adoption journey and calls out exactly who should keep reading.
Audience map
| Role | Start with | Why it matters |
|---|---|---|
| Platform & SRE teams | Operator handbook | Daily workflows, runbook snippets, and ready-to-ship checklists. |
| Infrastructure owners | Deployment playbook | Architecture patterns, automation hooks, and recovery drills. |
| Integrators & API teams | Integration guide | How to weave Velocity alongside HTTP/3, gRPC, and service meshes. |
| Security reviewers | Security overview | Cryptographic posture, incident flow, and compliance notes. |
| Performance enthusiasts | Benchmarking guide | Repeatable measurements plus tips for sharing results. |
How the docs are structured
- Get started: quick wins to bootstrap a pilot and understand terminology.
- Operate: everything you need once real traffic hits—deployment, integration, upgrades, KPIs.
- Security: posture, hardening, and specialised playbooks like the SSH migration path.
- Build: guidance for contributors working on Velocity itself.
Every page follows the same rhythm—context first, a concise action plan, then deep dives when you are ready. Key commands are copy-ready, tables summarise decisions, and “Next steps” links keep you moving.
Suggested reading arcs
- New adopter: Getting started → Operator handbook → Deployment playbook.
- Integrator: Integration guide → Benchmarking guide → Velocity release notes (coming soon).
- Security review: Security overview → Exploit hardening checklist → Velocity SSH migration.
Stay in the loop
- Watch the
docslabel on GitHub for new content drops. - Attend monthly office hours—agendas and recordings land in the #velocity-ops Slack channel within 24 hours.
- File documentation requests straight from any page; maintainers triage them weekly.