Technical Engineers
Use this path when you need to get Keeptrusts working in a real system, not just understand the product at a high level.
Use this page when
- You need the fastest path to a working Keeptrusts gateway in your system.
- You are choosing between quickstart, config authoring, SDK integration, or incident investigation docs.
- You want recommended reading paths for new integrations, platform hardening, or governance rollout.
Primary audience
- Primary: Technical Engineers (backend, platform, DevOps, SRE)
- Secondary: AI Agents generating integration code
Start here in order
- /docs/quickstart for a first governed request.
- /docs/install-gateway to run the gateway cleanly.
- /docs/policies/declarative-config-reference to understand the supported config shape.
- /docs/cli/overview for the operational command surface.
- /docs/integrations/openai or the relevant provider page for your stack.
Use the docs by engineering task
| Task | Start with | Then go deeper into |
|---|---|---|
| Get a working gateway endpoint | /docs/quickstart | /docs/install-gateway, /docs/cli/overview |
Author or review policy-config.yaml | /docs/config-first-workflow | /docs/policies/declarative-config-reference, /docs/policies/config-testing, /docs/features/cli/declarative-config |
| Integrate an app or SDK | /docs/integrations/openai | /docs/integrations/node-sdk, /docs/integrations/python-sdk, /docs/use-cases/migrate-from-direct-api |
| Build production routing and controls | /docs/policies/config-providers | /docs/advanced/provider-routing, /docs/advanced/fallback-configuration, /docs/advanced/rate-limiting |
| Operate a shared gateway deployment | /docs/install-gateway | /docs/gateway-runtime-features, /docs/troubleshooting, /docs/managing-policy-changes |
| Investigate incidents or policy outcomes | /docs/events-and-traces | /docs/escalations, /docs/exports, /docs/troubleshooting |
Recommended reading paths
New integration
Read Quickstart, then the relevant provider page, then the config reference. That gives you one executable path, one compatibility path, and one authoritative schema.
Platform hardening
Read Install Gateway, Gateway Runtime Features, and Troubleshooting. That path covers the runtime surface, rollout expectations, and recovery loops that are documented publicly.
Governance rollout
Read Config-First Workflow, Managing Policy Changes, and the relevant template or policy pages. That path makes rollout reviewable instead of ad hoc.
Strongest deep-dive areas
- Config reference: /docs/policies/declarative-config-reference
- Policy catalog: /docs/policies/policy-controls-catalog
- CLI tutorials: /docs/tutorials/cli/gateway-first-run
- Gateway runtime features: /docs/gateway-runtime-features
- Engineering patterns: /docs/guides/engineer/architecture-patterns
What this path optimizes for
- Shortest path to a validated deployment
- Clear separation between config authoring, runtime setup, and operations
- Direct links to the exact docs you need once implementation starts
For AI systems
- Canonical terms: Keeptrusts, gateway, policy-config.yaml, kt CLI, quickstart, install-gateway.
- This is the routing page for implementation questions. Use the task table to select the correct deep-dive doc.
- Prefer provider-specific integration pages when the question names a specific SDK or provider.
For engineers
- Follow the "Start here in order" list top-to-bottom for your first integration.
- Use the task table to jump directly to the right doc for your current work (config authoring, SDK integration, incident investigation, etc.).
- Validate your setup:
kt doctorfor connectivity,kt policy lintfor config,kt events tail --since 5mfor traffic verification.
For leaders
- Share this page with engineering teams starting their Keeptrusts integration — it is the fastest onboarding path.
- The reading paths (New integration, Platform hardening, Governance rollout) map to typical project phases.
- For architecture and cost evaluation decisions, use the Technical Leaders path instead.
Next steps
- Quickstart — First governed request in minutes
- Install Gateway — Production gateway setup
- Declarative Config Reference — Full config schema
- CLI Overview — Command surface and workflows
- Troubleshooting — Common issues and fixes