Verified with the coordinated workspace changes by devkit full run 2026-09-08T225814-186389-0000-3e3ed7cd (all seven phases passed). This shared UI pass does not mark the individual module reviews complete.
29 lines
1.7 KiB
Markdown
29 lines
1.7 KiB
Markdown
# GovOPlaN Workspace Codex Guide
|
|
|
|
## Scope
|
|
|
|
This repository coordinates the GovOPlaN workspace, release catalog, shared
|
|
checks, development environment, and cross-repository automation. Business and
|
|
platform behavior remains owned by the corresponding module repository.
|
|
|
|
## Documentation Contract
|
|
|
|
- Treat documentation as part of every behavior change. Update the owning module's manifest-driven `DocumentationTopic` contributions for each affected user and administrator workflow, setting, permission, limitation, and operational consequence.
|
|
- Keep feature content in the owning module. The optional `govoplan-docs` module projects module contributions and must not import feature internals.
|
|
- Every module manifest must provide a static user and administrator baseline, even when `documentation_providers` add configured-state details.
|
|
- Run `tools/checks/check-manifest-shapes.py` after module behavior or manifest changes. Run `tools/checks/check-focused.sh` for cross-module changes.
|
|
|
|
## Working Rules
|
|
|
|
- Start repeated workflows with `./devkit commands`; use `context --changed`,
|
|
`check --profile quick --changed --dry-run`, and `review MODULE` instead of
|
|
reconstructing repository/check inventories. See `docs/operations/DEVKIT.md`.
|
|
- Prefer compact check receipts (`status`, `summary`, `logs`) to repeated full
|
|
log dumps. `check --profile full` retains the required focused gate; targeted
|
|
profiles or cached results do not waive required verification or approvals.
|
|
|
|
- Treat Gitea issues as the canonical backlog and state log.
|
|
- Preserve optional module boundaries and use Core contracts or capabilities for integrations.
|
|
- Prefer targeted checks before full workspace scans.
|
|
- Do not start persistent development servers unless requested.
|