|
1 | | -# Capability: missing-command-docs |
2 | | - |
3 | | -Reference documentation for all previously undocumented commands across spec, govern, code-review, and codebase bundles. |
4 | | - |
5 | | -## Scenarios |
6 | | - |
7 | | -### Scenario: Each command page documents full option reference |
8 | | - |
9 | | -Given a command reference page (e.g., bundles/govern/enforce.md) |
10 | | -When a user reads the page |
11 | | -Then every option and argument from the command's --help output is documented |
12 | | -And practical examples demonstrate common usage patterns |
13 | | - |
14 | | -### Scenario: Spec bundle has complete documentation |
15 | | - |
16 | | -Given the spec bundle overview links to deep-dive pages |
17 | | -When a user follows links to validate, generate-tests, and mock |
18 | | -Then each page exists and contains command reference, examples, and related commands |
19 | | - |
20 | | -### Scenario: Govern bundle has complete documentation |
21 | | - |
22 | | -Given the govern bundle overview links to deep-dive pages |
23 | | -When a user follows links to enforce and patch |
24 | | -Then each page exists and contains command reference, examples, and related commands |
25 | | - |
26 | | -### Scenario: Code review bundle has complete documentation |
27 | | - |
28 | | -Given the code-review bundle overview links to deep-dive pages |
29 | | -When a user follows links to run, ledger, and rules |
30 | | -Then each page exists and contains command reference, examples, and related commands |
| 1 | +## ADDED Requirements |
| 2 | + |
| 3 | +### Requirement: Missing command reference pages SHALL document the implemented command surface |
| 4 | +Previously undocumented command pages SHALL describe the current option surface, examples, and relevant bundle-owned resource guidance for their commands. |
| 5 | + |
| 6 | +#### Scenario: Each command page documents full option reference |
| 7 | +- **GIVEN** a command reference page such as `bundles/govern/enforce.md` |
| 8 | +- **WHEN** a user reads the page |
| 9 | +- **THEN** every option and argument from the command's `--help` output is documented |
| 10 | +- **AND** practical examples demonstrate common usage patterns |
| 11 | + |
| 12 | +#### Scenario: Command pages explain bundle-owned resources where they affect usage |
| 13 | +- **GIVEN** a command reference page for a command that depends on migrated bundle-owned prompts or templates |
| 14 | +- **WHEN** a user reads the page |
| 15 | +- **THEN** the page explains the relevant setup or bootstrap path |
| 16 | +- **AND** it does not direct users to legacy core-owned resource locations |
| 17 | + |
| 18 | +#### Scenario: Spec bundle has complete documentation |
| 19 | +- **GIVEN** the spec bundle overview links to deep-dive pages |
| 20 | +- **WHEN** a user follows links to validate, generate-tests, and mock |
| 21 | +- **THEN** each page exists and contains command reference, examples, and related commands |
| 22 | + |
| 23 | +#### Scenario: Govern bundle has complete documentation |
| 24 | +- **GIVEN** the govern bundle overview links to deep-dive pages |
| 25 | +- **WHEN** a user follows links to enforce and patch |
| 26 | +- **THEN** each page exists and contains command reference, examples, and related commands |
| 27 | + |
| 28 | +#### Scenario: Code review bundle has complete documentation |
| 29 | +- **GIVEN** the code-review bundle overview links to deep-dive pages |
| 30 | +- **WHEN** a user follows links to run, ledger, and rules |
| 31 | +- **THEN** each page exists and contains command reference, examples, and related commands |
0 commit comments