GET STARTED

Velocity documentation hub

Map the Velocity library by audience and jump straight to the guide you need next.

Last updated November 5, 2025View on GitHub

Welcome to the Velocity docs

Velocity ships with opinionated guides for operators, developers, and security teams. Use this hub as your compass—each section highlights the outcome you unlock and the audience it supports.

Orientation map

Audience	Start here	Why it matters
Platform & SRE teams	Getting started	Prove Velocity on a pilot cluster with copy-ready commands.
Operations leads	Documentation guidebook	Understand how the library is organised and where to go next.
Developers & contributors	Developer guide	Explore workspace layout, coding standards, and required checks.
Security reviewers	Security design	Dig into threat modelling, cryptography choices, and incident flow.
Integrators	Integration guide	Embed Velocity alongside existing HTTP, gRPC, and mesh deployments.

Security & cryptography

Security design: Hybrid crypto rationale, PQ validation, and incident playbooks.
Velocity exploit hardening: Hardening flags, sandboxing, and red-team scenarios.
SSH over Velocity: Design summary for transporting SSH streams with a reversible rollout.
Velocity SSH migration: Step-by-step production migration plan.

Operations & performance

Deployment guide: Progressive rollout patterns, HA topologies, and disaster recovery.
Performance & security roadmap: Targets that shape tuning across pilots.
Benchmarking guide: Reproduce measurements and interpret telemetry with confidence.
Upgrade guide: Semver policy, regression checklists, and rollback strategies.

Build & extend

Quick start: Build, test, and explore the Velocity transport core on day one.
Developer guide: Contribution expectations and workspace automation.
User handbook: Operator workflows, ready-to-share runbooks, and daily checklists.

Next steps

Watch the docs label for fresh drops.
Join the VELO community calls for roadmap walkthroughs and Q&A.
Open issues from any page—the maintainers triage weekly and keep feedback loops tight.