base-layer/commandkit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Complete CommandKit consumer documentation

Browse Source
This commit is contained in:
Eric Rakestraw
2026-10-07 14:56:13 +00:00
parent 0af44a1172
commit 85f44cd358
17 changed files with 587 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/roadmap/implementation.md
View File

@@ -1,6 +1,6 @@
# Initial CommandKit implementation plan
Status: implementation underway; Stages 1-13 complete and Stage 14 pending.
Status: implementation complete; Stages 1-14 complete.
Date: 2026-10-07.
@@ -818,7 +818,7 @@ selection errors, optional capabilities, and help without engine construction.
## Stage 14: substantiate consumer fit and complete documentation
**Status:** pending. **Prerequisite:** Stage 13.
**Status:** complete. **Prerequisite:** Stage 13.
1. Add complete maintained examples using only the public root API and published
upstream packages. Use two ordinary example directories (separate Go main
@@ -860,8 +860,12 @@ selection errors, optional capabilities, and help without engine construction.
into the implementation. Record completed stage status and checks, then commit
the completed unit under the local policy. Publishing remains separate work.
**Completion evidence:** each included roadmap feature has observable behavior
and its appropriate checks; examples compile and use the real public dispatcher;
default tests do not require real services/credentials; documents describe only
implemented contracts. The final report identifies the commits, checks, and
deferred capabilities without claiming downstream migrations or release completion.
**Completion evidence:** added maintained `examples/simple` and
`examples/composed` consumers, public consumer guidance, internal architecture
overview, and updated CLI/development/README/feature-roadmap documentation. The
examples compile and use the public dispatcher with synthetic data. Shared
selector helpers serve both configuration suites. Reviewed exported declarations,
root and adapter imports, dependency replacements, attribution, and retained
deferred feature IDs. Verified with `gofmt`, `go test ./...`, `go mod tidy -diff`,
document link checks, example smoke commands, and `git diff --check`. Publishing,
downstream migrations, and deferred capabilities remain outside this stage.