Start Here
Learn Protocol Behavior
Section titled “Learn Protocol Behavior”Execute flows, inspect artifacts, and compare protocol mechanics.
- What You Can Do — capabilities and supported protocols
- Flow Walkthroughs — repeatable method for running any flow
- Protocol Catalog — all 8 protocol families with 42+ flows
Best for: security engineers, architects, product teams evaluating protocol behavior.
Deploy Services
Section titled “Deploy Services”Pull container images from GHCR and run services without building from source.
- Deploy Overview — registry namespace and available images
- Deployment Models — full stack, single service, or custom topology
- Release And Tag Policy — tag selection by environment
Best for: platform engineers, developers integrating ProtocolSoup into existing infrastructure.
Integrate APIs
Section titled “Integrate APIs”Use OpenAPI contracts to build against ProtocolSoup service APIs.
- API Overview — available APIs and recommended workflow
- Integration Patterns — gateway-first, direct, and hybrid patterns
First Reads
Section titled “First Reads”- Quickstart — running in under two minutes
- Platform At A Glance — architecture and request flow