generated from coulomb/repo-seed
CLI and API polish
This commit is contained in:
11
README.md
11
README.md
@@ -14,6 +14,9 @@ requirements documents in `wiki/`.
|
||||
- `wiki/ProductRequirementsDocument.md` - product scope and success criteria
|
||||
- `wiki/FunctionalRequirementsSpecification.md` - observable functional behavior
|
||||
- `docs/markitect-main-scope-assessment.md` - migration assessment from `markitect-main`
|
||||
- `docs/practical-usecase-relevance.md` - practical adoption usecases and relevance expectations
|
||||
- `docs/cli-reference.md` - generated `mkt` command reference
|
||||
- `docs/api-reference.md` - generated public API reference
|
||||
- `workplans/` - source-of-truth implementation and migration plans
|
||||
|
||||
## State Hub
|
||||
@@ -34,3 +37,11 @@ Try the parser CLI from a checkout:
|
||||
```bash
|
||||
PYTHONPATH=src python3 -m markitect_tool parse README.md --format tree
|
||||
```
|
||||
|
||||
Generate shell completion and reference docs:
|
||||
|
||||
```bash
|
||||
mkt completion bash > ~/.mkt-complete.bash
|
||||
mkt docs cli --output docs/cli-reference.md
|
||||
mkt docs api --output docs/api-reference.md
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user