Seed docs workflow and concept docs
This commit is contained in:
31
AGENTS.md
Normal file
31
AGENTS.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# GovOPlaN Docs Codex Guide
|
||||
|
||||
## Scope
|
||||
|
||||
This repository owns the `docs` module: configured-system documentation, documentation source contracts, evidence-aware help, documentation route contributions, module documentation indexing, docs-owned migrations if needed, and future `@govoplan/docs-webui`.
|
||||
|
||||
The module should describe the system that is actually configured first. It may show evidence about additional capabilities, installed-but-disabled features, or available extensions, but it should not force users through full-system documentation when their configured scope is smaller.
|
||||
|
||||
## Local Commands
|
||||
|
||||
Install and run through core:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-core
|
||||
./.venv/bin/python -m pip install -r requirements-dev.txt
|
||||
```
|
||||
|
||||
For combined checks once implementation starts, run:
|
||||
|
||||
```bash
|
||||
cd /mnt/DATA/git/govoplan-core
|
||||
./scripts/check-focused.sh
|
||||
```
|
||||
|
||||
## Working Rules
|
||||
|
||||
- Keep documentation-layer behavior in this module, not core.
|
||||
- Read configuration, module manifests, routes, permissions, and capability metadata through core contracts.
|
||||
- Do not import feature-module internals. Modules should contribute documentation metadata through manifests, capabilities, generated docs, or typed DTOs.
|
||||
- Prefer role-aware and configuration-aware documentation over global manuals.
|
||||
- Keep active backlog state in Gitea issues; keep durable context in repository docs and synced wiki pages.
|
||||
Reference in New Issue
Block a user