Remove markdown test docs and document tests inline
This commit is contained in:
@@ -96,15 +96,6 @@ Examples:
|
||||
│ ├─ package_skill_runtimes.sh
|
||||
│ ├─ skill-bundles.json
|
||||
│ └─ ...
|
||||
└─ docs/tests/
|
||||
├─ inbox/
|
||||
├─ orch/
|
||||
├─ repo-memory/
|
||||
├─ inbox-skill/
|
||||
├─ orch-skill/
|
||||
├─ council-review-skill/
|
||||
├─ repo-memory-skill/
|
||||
└─ ...
|
||||
```
|
||||
|
||||
## Package Boundaries
|
||||
@@ -314,28 +305,16 @@ Each runtime package owns:
|
||||
- integration tests
|
||||
- package-local fixtures
|
||||
|
||||
### CLI Markdown Test Plans
|
||||
### Test Intent Documentation
|
||||
|
||||
Standalone CLIs with user-facing contracts should also keep a Markdown test-plan
|
||||
set under `docs/tests/<cli>/`.
|
||||
User-facing test intent should live with the executable tests, not in a separate
|
||||
Markdown plan tree.
|
||||
|
||||
Examples:
|
||||
Required shape:
|
||||
|
||||
- `docs/tests/inbox/`
|
||||
- `docs/tests/orch/`
|
||||
- `docs/tests/repo-memory/`
|
||||
|
||||
### Skill Forward Tests
|
||||
|
||||
`docs/tests/*-skill/` remains skill-oriented.
|
||||
These tests validate the bundled skill behavior, not only the runtime package.
|
||||
|
||||
Examples:
|
||||
|
||||
- `docs/tests/inbox-skill/`
|
||||
- `docs/tests/orch-skill/`
|
||||
- `docs/tests/council-review-skill/`
|
||||
- `docs/tests/repo-memory-skill/`
|
||||
- add a short comment above each top-level test describing the behavior it protects
|
||||
- prefer package-local fixtures and helpers over cross-repo prose test plans
|
||||
- keep bundled-skill verification as executable tests or scripts, not as standalone Markdown inventories
|
||||
|
||||
### Cross-Package Validation
|
||||
|
||||
@@ -351,7 +330,7 @@ Keep documentation split by concern:
|
||||
|
||||
- runtime/package docs live under the owning package when tightly tied to implementation
|
||||
- cross-workspace architecture docs stay in root `docs/`
|
||||
- skill forward-test plans stay in `docs/tests/*-skill/`
|
||||
- test intent stays in executable test source through short comments above top-level test cases
|
||||
|
||||
This document becomes the repository-level source of truth for the workspace
|
||||
split.
|
||||
@@ -424,8 +403,6 @@ Changes:
|
||||
- move the exploratory repo-memory runtime into `packages/repo-memory-runtime`
|
||||
- normalize module pathing, tests, and packaging
|
||||
- add `skills/repo-memory`
|
||||
- add `docs/tests/repo-memory/`
|
||||
- add `docs/tests/repo-memory-skill/`
|
||||
|
||||
Exit criteria:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user