diff --git a/Home.md b/Home.md index 3104db1..97c5387 100644 --- a/Home.md +++ b/Home.md @@ -35,4 +35,4 @@ Two properties shape almost everything else: ## Keeping this wiki current is a required step -Not a nice-to-have: it is step 8 of the [workflow](Workflow) and is written into `CLAUDE.md`. A change that alters values, behaviour, conventions or pipelines updates the affected page in the same round of work — see [what obliges an edit and what does not](Workflow#the-wiki-is-part-of-the-work). +Not a nice-to-have: it is step 5 of the [workflow](Workflow) — before the merge is requested — and is written into `CLAUDE.md`. A change that alters values, behaviour, conventions or pipelines updates the affected page in the same round of work — see [what obliges an edit and what does not](Workflow#the-wiki-is-part-of-the-work). diff --git a/Workflow.md b/Workflow.md index b1b6dab..fde8a29 100644 --- a/Workflow.md +++ b/Workflow.md @@ -14,10 +14,10 @@ The split exists so that planning stays reviewable: a plan that is written, appr 2. **Document the final plan on the issue.** Once approved, it is posted as a comment before implementation starts — skipped only if the issue body already contains the full plan. Later decisions go there as comments too, so the issue stays the record. 3. **Delegate the implementation.** A development agent implements the issue completely on its own branch and opens a PR. 4. **The agent handles PR comments.** It watches its PR, addresses new review comments with code changes, replies on the thread and marks the thread **resolved**. -5. **The agent terminates itself** once its PR has been merged or closed. -6. **The user merges.** Never merge yourself, and never arm auto-merge on your own PR. Only after the merge may work on the next issue begin. -7. **Verify the linked issue was closed** after the merge. Gitea auto-closes on the same keywords as GitHub, but only for an issue in the **same repository** — a migrated issue whose number changed is closed by hand. -8. **Update the wiki.** See below. It is part of the work, not a follow-up. +5. **Update the wiki** — as part of the issue, before the merge is requested, so that code and documentation are reviewed together. See below. It is part of the work, not a follow-up. +6. **The agent terminates itself** once its PR has been merged or closed. +7. **The user merges.** Never merge yourself, and never arm auto-merge on your own PR. Only after the merge may work on the next issue begin. +8. **Verify the linked issue was closed** after the merge — and that the wiki edit really landed. Gitea auto-closes on the same keywords as GitHub, but only for an issue in the **same repository**; a migrated issue whose number changed is closed by hand. ## The wiki is part of the work @@ -38,7 +38,7 @@ This wiki is the knowledge base. A change that lands in `main` while the wiki st **What does not oblige an edit:** a plain app-version bump. Renovate automerges those continuously and does not touch the wiki; chart pages therefore quote versions as snapshots and point at `Chart.yaml` as the source of truth. If an app-version bump *does* change behaviour or values, it is no longer a plain bump and the table above applies. -**Where the duty sits in the workflow:** the development agent updates the wiki as part of its issue, before asking for the merge, so that the reviewer sees code and documentation together. The manager checks it at step 7, along with the issue closure. +**Where the duty sits in the workflow:** the development agent updates the wiki as part of its issue, before asking for the merge, so that the reviewer sees code and documentation together. The manager checks it at step 8, along with the issue closure. **How to edit.** The wiki is a separate git repository: