Skip to content

Commit 453de41

Browse files
committed
docs: refine DocFX site and API layout
1 parent b184f5f commit 453de41

21 files changed

Lines changed: 1527 additions & 538 deletions

.github/workflows/publish-docs.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,6 @@ jobs:
3535
- name: Build docs
3636
run: docfx docfx.json
3737

38-
- name: Copy root index
39-
run: cp index.html _site/index.html
40-
4138
- name: Mark site as non-Jekyll
4239
run: touch _site/.nojekyll
4340

Docs/API/API.md

Lines changed: 0 additions & 158 deletions
This file was deleted.

Docs/API/Redis.md

Lines changed: 0 additions & 136 deletions
This file was deleted.

Docs/API/Reference.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# API Reference
22

3-
DocFX generates the public API reference from the compiled assemblies and XML documentation files.
3+
DocFX generates the public API reference from the project code, compiled assemblies, and XML
4+
documentation files.
45

56
## Included packages
67

78
- `ModularityKit.Mutator`
89
- `ModularityKit.Mutator.Governance`
910
- `ModularityKit.Mutator.Governance.Redis`
1011

11-
## Build locally
12+
## Browse the generated API
1213

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

18-
The rendered API pages appear under the `API` section of the generated site.
17+
- [Core package root](../../obj/api/core/ModularityKit.Mutator.Abstractions.html)
18+
- [Governance package root](../../obj/api/governance/ModularityKit.Mutator.Governance.Abstractions.html)
19+
- [Redis provider root](../../obj/api/redis/ModularityKit.Mutator.Governance.Redis.html)

Docs/Decision/Adr/ADR_012_Mutation_Execution_Interfaces_and_Context _Separation.md renamed to Docs/Decision/Adr/ADR_012_Mutation_Execution_Interfaces_and_Context_Separation.md

File renamed without changes.

Docs/Decision/Adr/ADR_013_Mutation_Engine_and_Executor_Runtime _Integration.md renamed to Docs/Decision/Adr/ADR_013_Mutation_Engine_and_Executor_Runtime_Integration.md

File renamed without changes.

Docs/Home.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
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+
16
![ModularityKit.Mutator](../assets/brand/mutator-landing-banner.png)
27

3-
# ModularityKit.Mutator
8+
## Start here
49

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)
715

816
## Packages
917

1018
| Package | What it covers |
1119
| --- | --- |
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 |
1422
| [`ModularityKit.Mutator.Governance.Redis`](../src/Redis/README.md) | Redis-backed storage and query provider |
1523

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
2625

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

3131
## Build locally
@@ -34,5 +34,4 @@ and Redis-backed storage.
3434
dotnet tool update -g docfx
3535
dotnet build ModularityKit.Mutator.slnx -c Release
3636
docfx docfx.json
37-
cp index.html _site/index.html
3837
```

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ Build the DocFX site locally with:
4545
dotnet tool update -g docfx
4646
dotnet build ModularityKit.Mutator.slnx -c Release
4747
docfx docfx.json
48-
cp index.html _site/index.html
4948
```
5049

5150
The generated site includes the conceptual docs under `Docs/` and the public API reference for the

0 commit comments

Comments
 (0)