Route documentation navigation to current contract owners
This commit is contained in:
13
README.md
13
README.md
@@ -22,12 +22,17 @@ The [consumer guide](docs/consumers/guide.md) links to two maintained examples:
|
|||||||
- [Consumer guide](docs/consumers/guide.md)
|
- [Consumer guide](docs/consumers/guide.md)
|
||||||
- [Internal package overview](docs/internal/overview.md)
|
- [Internal package overview](docs/internal/overview.md)
|
||||||
- [Architecture policy](docs/policy/architecture.md)
|
- [Architecture policy](docs/policy/architecture.md)
|
||||||
- [CLI standard proposal](docs/roadmap/01-cli-plan.md)
|
|
||||||
- [Dispatcher implementation roadmap](docs/roadmap/02-dispatch.md)
|
|
||||||
- [Backend implementation roadmap](docs/roadmap/03-backend.md)
|
|
||||||
- [Public facade implementation roadmap](docs/roadmap/04-facade.md)
|
|
||||||
- [Policy provenance](docs/policy/meta.md)
|
- [Policy provenance](docs/policy/meta.md)
|
||||||
|
|
||||||
|
## Planning history and future work
|
||||||
|
|
||||||
|
- [Initial delivery and deferred capabilities](docs/roadmap/initial.md)
|
||||||
|
- [Completed implementation record](docs/roadmap/implementation.md)
|
||||||
|
- [Historical CLI planning](docs/roadmap/01-cli-plan.md)
|
||||||
|
- [Completed dispatcher planning](docs/roadmap/02-dispatch.md)
|
||||||
|
- [Completed backend planning](docs/roadmap/03-backend.md)
|
||||||
|
- [Completed facade planning](docs/roadmap/04-facade.md)
|
||||||
|
|
||||||
CommandKit is licensed under the [LGPL v3.0 or later](COPYRIGHT).
|
CommandKit is licensed under the [LGPL v3.0 or later](COPYRIGHT).
|
||||||
|
|
||||||
[Open Source attribution notices](docs/oss/attribution.md) are available.
|
[Open Source attribution notices](docs/oss/attribution.md) are available.
|
||||||
|
|||||||
@@ -48,15 +48,21 @@ canonical documentation owners.
|
|||||||
| Task | Read |
|
| Task | Read |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| Implemented CLI behavior | [CLI reference](cli.md) |
|
| Implemented CLI behavior | [CLI reference](cli.md) |
|
||||||
| Standard command vocabulary, reports, or remaining operator-contract proposals | [CLI plan](roadmap/01-cli-plan.md) |
|
| Public API usage and standard-suite wiring | [Consumer guide](consumers/guide.md), [configuration declarations](../config.go), [PromptKit declarations](../promptkit.go), and applicable ADRs |
|
||||||
| Dispatcher, registration, or typed input design | [Dispatcher roadmap](roadmap/02-dispatch.md) and [ADR 0001](adr/0001-command-dispatch-and-inputs.md) |
|
| Dispatcher, registration, or typed inputs | [Command declarations](../command.go), [bindings](../binding.go), [invocation](../execute.go), and [ADR 0001](adr/0001-command-dispatch-and-inputs.md) |
|
||||||
| Backend integration | [Backend roadmap](roadmap/03-backend.md) and [ADR 0002](adr/0002-cobra-backend.md) |
|
| Backend integration | [Internal overview](internal/overview.md), [adapter implementation](../internal/cobra/parse.go), and [ADR 0002](adr/0002-cobra-backend.md) |
|
||||||
| Public API or internal adapter boundaries | [Facade roadmap](roadmap/04-facade.md), [ADR 0003](adr/0003-public-facade.md), and the architecture policy |
|
| Public facade or adapter boundaries | [Internal overview](internal/overview.md), [ADR 0003](adr/0003-public-facade.md), and the architecture policy |
|
||||||
|
| Deferred capabilities and delivery scope | [Initial feature target](roadmap/initial.md#deferred-capability-targets) and [explicit deferrals](roadmap/initial.md#explicit-deferrals) |
|
||||||
|
| Initial planning history | [CLI](roadmap/01-cli-plan.md), [dispatcher](roadmap/02-dispatch.md), [backend](roadmap/03-backend.md), [facade](roadmap/04-facade.md), and [completed staged plan](roadmap/implementation.md) |
|
||||||
| Licensing or incorporated material | [Project grant](../COPYRIGHT), [license texts](../LICENSE), and [attribution](oss/attribution.md) |
|
| Licensing or incorporated material | [Project grant](../COPYRIGHT), [license texts](../LICENSE), and [attribution](oss/attribution.md) |
|
||||||
| Policy provenance | [Policy provenance](policy/meta.md) |
|
| Policy provenance | [Policy provenance](policy/meta.md) |
|
||||||
|
|
||||||
Read all applicable rows for cross-cutting work. These roadmaps describe future
|
Read all applicable rows for cross-cutting work. Go declarations and GoDoc own
|
||||||
implementation; their illustrative Go types and package layouts are not APIs.
|
current exported contracts; the CLI reference owns operator behavior. Numbered
|
||||||
|
roadmaps are completed planning records. Retained illustrations and historical
|
||||||
|
staged instructions are not current API references or assignments to restart
|
||||||
|
implementation. Future capabilities remain explicitly identified in the feature
|
||||||
|
roadmap.
|
||||||
|
|
||||||
## Documentation validation
|
## Documentation validation
|
||||||
|
|
||||||
@@ -75,8 +81,9 @@ git diff --cached --check -- '*.md' COPYRIGHT
|
|||||||
|
|
||||||
These commands do not cover untracked files. Review their contents and whitespace
|
These commands do not cover untracked files. Review their contents and whitespace
|
||||||
before staging, or use the staged check after staging only the intended files.
|
before staging, or use the staged check after staging only the intended files.
|
||||||
Sibling-checkout evidence links in the CLI proposal are review references, not
|
Sibling-checkout evidence links in the CLI planning record are historical review
|
||||||
build dependencies; durable implemented contracts will belong in CommandKit.
|
references, not build dependencies. Implemented contracts belong in CommandKit
|
||||||
|
under their canonical owners.
|
||||||
|
|
||||||
Run `go test ./...` from the repository root to compile the module and run its
|
Run `go test ./...` from the repository root to compile the module and run its
|
||||||
deterministic tests. Format changed Go files with `gofmt`. The release procedure
|
deterministic tests. Format changed Go files with `gofmt`. The release procedure
|
||||||
|
|||||||
@@ -198,13 +198,15 @@ Owner: [internal/overview.md](../internal/overview.md).
|
|||||||
|
|
||||||
Owners: [development.md](../development.md) and [README.md](../../README.md).
|
Owners: [development.md](../development.md) and [README.md](../../README.md).
|
||||||
|
|
||||||
- [ ] Route current implementation work to GoDoc, consumer guidance, CLI
|
- [x] Route current implementation work to GoDoc, consumer guidance, CLI
|
||||||
reference, internal overview, and applicable ADRs/policies.
|
reference, internal overview, and applicable ADRs/policies.
|
||||||
- [ ] Label the older numbered roadmaps as completed/historical planning rather
|
- [x] Label the older numbered roadmaps as completed/historical planning rather
|
||||||
than the active source of unresolved implementation decisions.
|
than the active source of unresolved implementation decisions.
|
||||||
- [ ] Update README roadmap labels/navigation to match the reconciled statuses.
|
- [x] Update README roadmap labels/navigation to match the reconciled statuses.
|
||||||
Keep genuine future-work navigation discoverable without duplicating contracts.
|
Keep genuine future-work navigation discoverable without duplicating contracts.
|
||||||
|
|
||||||
|
**Completion:** Routed current work to canonical contracts and mechanics, labeled completed planning records, and exposed genuine deferrals separately.
|
||||||
|
|
||||||
## D-11: remove temporary references from durable ADRs
|
## D-11: remove temporary references from durable ADRs
|
||||||
|
|
||||||
Owners:
|
Owners:
|
||||||
|
|||||||
Reference in New Issue
Block a user