Reignite developer documentation
Reignite is a production performance-diagnostics service. In-process profiler agents watch a customer application, capture a trace or memory dump when a threshold is breached, and upload the artifact to the Reignite control plane. A Reignite analyst turns that artifact into a root cause and a reviewable fix, and the control plane keeps the whole trace lifecycle auditable.
This site is for the people who integrate, operate and extend that platform:
| I need to… | Start here |
|---|---|
| Understand the system shape before I integrate | Architecture |
| Install a profiler and send my first trace | Integration |
| Work on the Teams diagnostics bots | Diagnostics |
| Build, test or deploy a Reignite service | Contributing |
| Look up an environment, entity or API surface | Reference |
How this site is built
The diagrams and reference tables are generated from a model, not hand-drawn:
architecture/model.yaml
is the single source of truth for the systems, containers, repositories, environments and
end-to-end flows. A small .NET generator turns that model into the Mermaid diagrams and tables
on these pages, and DocFX renders them.
That means a change to the architecture is one edit in the model, not a hunt through prose. The generated pages carry a "do not edit" banner; the hand-written pages link to them.
flowchart LR
Model["architecture/model.yaml"] --> Generator["Reignite.Docs.Generator"]
Generator --> Markdown["Mermaid diagrams and tables"]
Markdown --> DocFX["DocFX modern template"]
DocFX --> Site["docs.reigniteperformance.com"]
Documentation principles
- External views, not internals. The architecture pages describe systems, containers and interactions. Class-level implementation detail belongs in the owning repository.
- The model is the source. Systems, containers, repositories, environments and flows are
edited in
architecture/model.yamland regenerated. - Every claim has an owner. Repository links and environment URLs live in the model so a reader can go from a diagram to the code that implements it.
- Security is part of the architecture. Secrets, tokens and SAS URLs are called out where they cross a boundary, never printed in full.