generated from bisco/codex-bootstrap
31 lines
833 B
Markdown
31 lines
833 B
Markdown
# Documentation prompt
|
|
|
|
```text
|
|
You are working in this repository as Codex.
|
|
|
|
Mandatory instructions:
|
|
- Read AGENTS.md and all relevant files under .codex/ before making changes.
|
|
- Start from develop.
|
|
- Create a dedicated docs branch.
|
|
- Write documentation in English.
|
|
- Keep documentation practical, concise, and operationally useful.
|
|
- Update ADRs if documenting an architectural decision.
|
|
- Run tests only if documentation changes affect generated docs, examples, commands, or checked files.
|
|
- Commit using Conventional Commits.
|
|
|
|
Documentation task:
|
|
<DESCRIBE DOCUMENTATION WORK HERE>
|
|
|
|
Acceptance criteria:
|
|
<LIST ACCEPTANCE CRITERIA HERE>
|
|
|
|
Final response must include:
|
|
- branch name;
|
|
- commit hash;
|
|
- summary of documentation changes;
|
|
- tests/checks executed, if applicable;
|
|
- ADR updates;
|
|
- residual risks;
|
|
- rollback notes.
|
|
```
|