1.9 KiB
1.9 KiB
id, title, status, wave, depends_on, plan, spec
| id | title | status | wave | depends_on | plan | spec | |
|---|---|---|---|---|---|---|---|
| 03-runtime-ownership-docs | Document runtime ownership | completed | 2 |
|
plan.md | ../../specs/executors/requirements/port-collision-safety.md |
Task 03: Document Runtime Ownership
Document the one-home ownership rule and the safe command for an isolated backend-only instance.
Acceptance
- Public development docs state that one backend owns a Kandev home at a time.
- Raw backend commands explain their default-home behavior and show the existing isolated
KANDEV_HOME_DIRcommand. - The docs do not tell users to remove a stale lock file.
Verification
Run these commands from the repository root:
node --test scripts/validate-public-docs.test.mjs
node scripts/validate-public-docs.mjs
git diff --check
Files Likely Touched
docs/public/backend-development.mddocs/public/contributing.mddocs/public/configuration.md
Dependencies
Task 01.
Parallelism
sequential. The final error behavior and ownership scope must match Task 01.
Inputs
- Spec section Exclusive runtime-state ownership.
- Plan section Public Documentation.
- Docs-maintainer guidance for development and configuration pages.
Risks
- Keep
make devdistinct from rawmake dev-backendandmake -C apps/backend devbehavior. - Do not expose the lock file as a user-managed control.
Output Contract
Report the changed pages, their primary Diataxis type, exact test results, blockers, and risks.
Update this task and plan.md in the same conversation.
Results
- Documented one-backend-per-home ownership in backend development, contribution, and configuration guidance.
- Documented separate home, database, and port requirements for intentional second instances.
- Verification:
node --test scripts/validate-public-docs.test.mjspassed (58 tests);node scripts/validate-public-docs.mjsvalidated 41 published pages.