Skip to content

Feat: Improve governance DX and docs#40

Merged
rian-be merged 3 commits into
mainfrom
develop
Jun 29, 2026
Merged

Feat: Improve governance DX and docs#40
rian-be merged 3 commits into
mainfrom
develop

Conversation

@rian-be

@rian-be rian-be commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR improves governance API ergonomics and restructures the API documentation into a clearer package oriented layout. It reduces call site noise in governance flows, updates the examples to use the shorter patterns, and adds dedicated API guides for governance and Redis.

Added

  • category specific MutationRequestDecision helpers for lifecycle, approval, and version-resolution decisions
  • IVersionedState execution overload for IGovernanceExecutionManager.ExecuteApproved(...)
  • dedicated Docs/API/ folder with separate governance, Redis, and core API reference documents
  • focused tests covering the new MutationRequestDecision helper methods

Changed

  • governance request factories now use the category specific decision helpers internally
  • governance runtime execution, approval, and version resolution paths now use the shorter decision APIs
  • governance examples now demonstrate the simplified DX patterns
  • governance and Redis package READMEs now point to the dedicated API docs

Result

The governance surface is now shorter and more consistent at the call site. Common operations such as request creation, decision recording, and approved execution require less boilerplate, and the documentation now separates core, governance, and Redis usage more clearly.

Testing

  • verified dotnet test Tests/ModularityKit.Mutator.Governance.Tests/ModularityKit.Mutator.Governance.Tests.csproj
  • verified dotnet build Examples/Governance/GovernedExecution/GovernedExecution.csproj
  • verified dotnet build Examples/Governance/Queries/Queries.csproj
  • verified dotnet build Examples/Governance/RedisQueries/RedisQueries.csproj
  • verified dotnet build Examples/Governance/DecisionTaxonomy/DecisionTaxonomy.csproj

Checklist

  • governance decision creation has dedicated DX helpers
  • approved execution supports the IVersionedState shortcut overload
  • governance examples are updated to use the shorter API surface
  • API documentation is split into dedicated core, governance, and Redis guides

@github-actions github-actions Bot added documentation Documentation updates and additions abstractions Public abstractions and contracts runtime Runtime implementation and execution flow examples Runnable examples and sample apps tests Test coverage and test changes labels Jun 29, 2026
@rian-be rian-be changed the title [codex] Improve governance DX and docs Feat: Improve governance DX and docs Jun 29, 2026
@rian-be rian-be self-assigned this Jun 29, 2026
@rian-be rian-be marked this pull request as ready for review June 29, 2026 19:40
@rian-be rian-be merged commit 833687d into main Jun 29, 2026
27 of 28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

abstractions Public abstractions and contracts documentation Documentation updates and additions examples Runnable examples and sample apps runtime Runtime implementation and execution flow tests Test coverage and test changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant