Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
158 changes: 0 additions & 158 deletions Docs/API/API.md

This file was deleted.

136 changes: 0 additions & 136 deletions Docs/API/Redis.md

This file was deleted.

15 changes: 8 additions & 7 deletions Docs/API/Reference.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
# API Reference

DocFX generates the public API reference from the compiled assemblies and XML documentation files.
DocFX generates the public API reference from the project code, compiled assemblies, and XML
documentation files.

## Included packages

- `ModularityKit.Mutator`
- `ModularityKit.Mutator.Governance`
- `ModularityKit.Mutator.Governance.Redis`

## Build locally
## Browse the generated API

```bash
dotnet tool update -g docfx
docfx docfx.json
```
Use the package roots below to explore the public types for each package. These pages are generated
from the code, not hand-written docs:

The rendered API pages appear under the `API` section of the generated site.
- [Core package root](../../obj/api/core/ModularityKit.Mutator.Abstractions.html)
- [Governance package root](../../obj/api/governance/ModularityKit.Mutator.Governance.Abstractions.html)
- [Redis provider root](../../obj/api/redis/ModularityKit.Mutator.Governance.Redis.html)
30 changes: 15 additions & 15 deletions Docs/Home.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
# ModularityKit.Mutator

ModularityKit.Mutator is a .NET mutation runtime with governance, request lifecycle control,
approval flow, and Redis-backed storage.

![ModularityKit.Mutator](../assets/brand/mutator-landing-banner.png)

# ModularityKit.Mutator
## Start here

ModularityKit.Mutator is a .NET mutation runtime with governance, request lifecycle, approval flow,
and Redis-backed storage.
- [API reference](API/Reference.md)
- [Architecture](Architecture.md)
- [Core concepts](Core-Concepts.md)
- [Execution model](ExecutionModel.md)
- [ADR index](Decision/listadr.md)

## Packages

| Package | What it covers |
| --- | --- |
| [`ModularityKit.Mutator`](../src/README.md) | mutation runtime, policies, execution, audit, history |
| [`ModularityKit.Mutator.Governance`](../src/Governance/README.md) | request lifecycle, approvals, resolution, governed execution |
| [`ModularityKit.Mutator`](../src/README.md) | mutation runtime, policies, execution, audit, and history |
| [`ModularityKit.Mutator.Governance`](../src/Governance/README.md) | request lifecycle, approvals, resolution, and governed execution |
| [`ModularityKit.Mutator.Governance.Redis`](../src/Redis/README.md) | Redis-backed storage and query provider |

## Explore

| Area | What to read |
| --- | --- |
| API reference | [`Docs/API/Reference.md`](API/Reference.md) |
| Core concepts | [`Docs/Core-Concepts.md`](Core-Concepts.md) |
| Execution model | [`Docs/ExecutionModel.md`](ExecutionModel.md) |
| Roadmap | [`Docs/Roadmap.md`](Roadmap.md) |

## What this site contains
## What is covered

- package overviews for the runtime and governance extensions
- conceptual docs for the mutation model and request flow
- decision records for architecture-level changes
- generated API reference from XML docs

## Build locally
Expand Down
Loading
Loading