|
| 1 | +# ModularityKit.Mutator |
| 2 | + |
| 3 | +ModularityKit.Mutator is a .NET mutation runtime with governance, request lifecycle control, |
| 4 | +approval flow, and Redis-backed storage. |
| 5 | + |
1 | 6 |  |
2 | 7 |
|
3 | | -# ModularityKit.Mutator |
| 8 | +## Start here |
4 | 9 |
|
5 | | -ModularityKit.Mutator is a .NET mutation runtime with governance, request lifecycle, approval flow, |
6 | | -and Redis-backed storage. |
| 10 | +- [API reference](API/Reference.md) |
| 11 | +- [Architecture](Architecture.md) |
| 12 | +- [Core concepts](Core-Concepts.md) |
| 13 | +- [Execution model](ExecutionModel.md) |
| 14 | +- [ADR index](Decision/listadr.md) |
7 | 15 |
|
8 | 16 | ## Packages |
9 | 17 |
|
10 | 18 | | Package | What it covers | |
11 | 19 | | --- | --- | |
12 | | -| [`ModularityKit.Mutator`](../src/README.md) | mutation runtime, policies, execution, audit, history | |
13 | | -| [`ModularityKit.Mutator.Governance`](../src/Governance/README.md) | request lifecycle, approvals, resolution, governed execution | |
| 20 | +| [`ModularityKit.Mutator`](../src/README.md) | mutation runtime, policies, execution, audit, and history | |
| 21 | +| [`ModularityKit.Mutator.Governance`](../src/Governance/README.md) | request lifecycle, approvals, resolution, and governed execution | |
14 | 22 | | [`ModularityKit.Mutator.Governance.Redis`](../src/Redis/README.md) | Redis-backed storage and query provider | |
15 | 23 |
|
16 | | -## Explore |
17 | | - |
18 | | -| Area | What to read | |
19 | | -| --- | --- | |
20 | | -| API reference | [`Docs/API/Reference.md`](API/Reference.md) | |
21 | | -| Core concepts | [`Docs/Core-Concepts.md`](Core-Concepts.md) | |
22 | | -| Execution model | [`Docs/ExecutionModel.md`](ExecutionModel.md) | |
23 | | -| Roadmap | [`Docs/Roadmap.md`](Roadmap.md) | |
24 | | - |
25 | | -## What this site contains |
| 24 | +## What is covered |
26 | 25 |
|
27 | 26 | - package overviews for the runtime and governance extensions |
28 | 27 | - conceptual docs for the mutation model and request flow |
| 28 | +- decision records for architecture-level changes |
29 | 29 | - generated API reference from XML docs |
30 | 30 |
|
31 | 31 | ## Build locally |
|
0 commit comments