15 lines
974 B
Markdown
15 lines
974 B
Markdown
|
---
|
||
|
|
name: docs_keep_updated
|
||
|
|
description: "Keep documentation in sync with every change as part of the work, not a separate step"
|
||
|
|
metadata:
|
||
|
|
node_type: memory
|
||
|
|
type: feedback
|
||
|
|
originSessionId: ca09fbe4-9226-4ad9-874f-04df90840eef
|
||
|
|
---
|
||
|
|
|
||
|
|
When changing config or code, update the affected documentation in the same pass — READMEs, KEYBINDINGS, per-host install notes, module comments. Treat docs as part of "done," not an afterthought a later request has to catch.
|
||
|
|
|
||
|
|
**Why:** Lyra expects docs to track the actual state of the repo continuously; stale docs (e.g. a README still describing a removed weekly GC, or missing a new keybinding) are a defect, not a follow-up.
|
||
|
|
|
||
|
|
**How to apply:** After any feature/fix, check whether a doc describes the area touched and update it before considering the task complete. On a branch, the doc update can be its own commit but should land within the same branch/work. Relates to [[git_conventions]] and [[workflow_review_and_comments]].
|