From 0b442426055fc4a98904c9ab54b21dc2be074414 Mon Sep 17 00:00:00 2001 From: Tom Softreck Date: Sat, 19 Sep 2026 13:54:15 +0200 Subject: [PATCH] feat(docs): adopt wellmanifest docs and conform metadata (ticket-169) --- .governance/docs.json | 7 ++ docs/README.md | 2 + docs/information/adoption-command-adapter.md | 17 +++- docs/information/adoption-transactions.md | 2 +- project/TICKETS.md | 1 + project/ticket-169/README.md | 24 +++++ project/ticket-169/intent.json | 96 ++++++++++++++++++++ 7 files changed, 145 insertions(+), 4 deletions(-) create mode 100644 .governance/docs.json create mode 100644 project/ticket-169/README.md create mode 100644 project/ticket-169/intent.json diff --git a/.governance/docs.json b/.governance/docs.json new file mode 100644 index 0000000..7f54a96 --- /dev/null +++ b/.governance/docs.json @@ -0,0 +1,7 @@ +{ + "schema": "wellmanifest.docs/adoption/v1", + "repository": "semcod/goal", + "standard": "wellmanifest/docs", + "source_revision": "19efafbeb18923cfd51cc69bd519330488500137", + "policy_sha256": "fac05e720ec49370ba393e817a4a03b895d7ed33828e09b3420f9fcfb09264b0" +} diff --git a/docs/README.md b/docs/README.md index 86cb662..2f6e4c1 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,6 +12,8 @@ or turn embedded examples into executable policy contracts. - [Markdown output](FEATURE/MARKDOWN_OUTPUT.md) — command defaults, optional metadata and report limits. - [Markdown integration](SERVICE/MARKDOWN_OUTPUT_INTEGRATION.md) — capture output, preserve exit codes and protect artifacts. +- [Adoption command adapter](information/adoption-command-adapter.md) — Goal command adapter for adoption transactions. +- [Adoption transactions](information/adoption-transactions.md) — Resumable adoption transactions. - [Legacy overview](markdown-output.md) and [legacy guide](markdown-output-guide.md) — original entry paths and heading links. # goal diff --git a/docs/information/adoption-command-adapter.md b/docs/information/adoption-command-adapter.md index c406e8b..bae5831 100644 --- a/docs/information/adoption-command-adapter.md +++ b/docs/information/adoption-command-adapter.md @@ -12,7 +12,7 @@ "review_after": "2026-09-21", "source_revision": "2d86db24a21ff096cba87f0977e3ff9548797856", "affected_repositories": ["semcod/goal"], - "evidence": ["goal/governance/adoption_transaction.py", "tests/test_adoption_transaction.py", "goal/cli/governance_cmd.py"] + "evidence": ["repo://goal/governance/adoption_transaction.py", "repo://tests/test_adoption_transaction.py", "repo://goal/cli/governance_cmd.py"] } --- @@ -25,6 +25,11 @@ `goal governance adopt` command. It does not clone the generator, invent another journal, or supply independent authorization and receipt providers. + +## Scope + +Integration ticket-107 and Goal command adapter interface. + ## Contract @@ -84,7 +89,6 @@ bounded diagnostics. Processes that deliberately escape the process group are outside this adapter's containment contract; the execution profile must prevent that behavior or provide a stronger supervisor. - ## Validation Isolated Git fixtures cover stale inputs, foreign subjects and keys, authority @@ -103,7 +107,14 @@ one adoption invocation. This is an isolated process-boundary simulation, not an attestation of a deployed daemon or a power-loss recovery test. -## Remaining integration +## Limitations + +This is an optional library adapter, not a deployed migration daemon. Before a +live pilot, supply protected profile/catalog resolution, authoritative adoption +readback, scoped lease authorization and real validation/publication delegates. + + +## Remaining integration and next actions This is an optional library adapter, not a deployed migration daemon. Before a live pilot, supply protected profile/catalog resolution, authoritative adoption diff --git a/docs/information/adoption-transactions.md b/docs/information/adoption-transactions.md index f9d1c8b..bfcfc7b 100644 --- a/docs/information/adoption-transactions.md +++ b/docs/information/adoption-transactions.md @@ -12,7 +12,7 @@ "review_after": "2026-09-21", "source_revision": "fabdc0c143c012f56e0f2ec1d009a07fadf7ff16", "affected_repositories": ["semcod/goal"], - "evidence": ["project/ticket-107/intent.json"] + "evidence": ["repo://project/ticket-107/intent.json"] } --- diff --git a/project/TICKETS.md b/project/TICKETS.md index feb83f4..ab8256e 100644 --- a/project/TICKETS.md +++ b/project/TICKETS.md @@ -111,4 +111,5 @@ This file indexes governance tickets without taking ownership of | **ticket-111** | [`README.md`](./ticket-111/README.md) | - | - | [`ai-codex.md`](./ticket-111/ai-codex.md) | - | - | | **ticket-112** | [`README.md`](./ticket-112/README.md) | - | - | [`ai-codex.md`](./ticket-112/ai-codex.md) | - | - | | **ticket-168** | [`README.md`](./ticket-168/README.md) | - | - | - | - | - | +| **ticket-169** | [`README.md`](./ticket-169/README.md) | - | - | - | - | - | diff --git a/project/ticket-169/README.md b/project/ticket-169/README.md new file mode 100644 index 0000000..2f83a9b --- /dev/null +++ b/project/ticket-169/README.md @@ -0,0 +1,24 @@ +# Ticket 169: Adopt wellmanifest docs standard and normalize documentation metadata + +- **ID**: ticket-169 +- **Owner**: agent:gemini +- **Status**: IN_PROGRESS +- **Workflow state**: EDIT +- **Created**: 2026-09-19 +- **Authorization**: SESSION_EXECUTION_AUTHORIZATION + +## Goal and scope + +Adopt `wellmanifest/docs` standard in `semcod/goal` at revision `19efafbeb18923cfd51cc69bd519330488500137`, add `.governance/docs.json`, link canonical documentation in `docs/README.md`, and normalize information metadata and section markers to pass docs check. + +## Acceptance criteria + +- [x] AC-01: Add `.governance/docs.json` pinning `wellmanifest/docs@19efafbeb18923cfd51cc69bd519330488500137`. +- [x] AC-02: Normalize evidence URIs and required sections in `docs/information/`. +- [x] AC-03: Pass `python3 .../check.py` from `wellmanifest/docs`. +- [x] AC-04: Pass `./project/governance-check.sh`. + +## Tracking boundary + +This directory contains the minimal reviewed intent. Optional participant prose +and raw command logs are not required delivery output. diff --git a/project/ticket-169/intent.json b/project/ticket-169/intent.json new file mode 100644 index 0000000..e54a28f --- /dev/null +++ b/project/ticket-169/intent.json @@ -0,0 +1,96 @@ +{ + "schema": "new-project.intent/v3", + "ticket": "ticket-169", + "summary": "Adopt wellmanifest docs standard and normalize documentation metadata", + "workstream": "integration", + "classification": { + "kind": "FEATURE", + "priority": "P2", + "origin": "health" + }, + "allowedPaths": [ + "project/ticket-169/**", + "project/TICKETS.md", + ".governance/docs.json", + "docs/README.md", + "docs/information/adoption-command-adapter.md", + "docs/information/adoption-transactions.md" + ], + "forbiddenPaths": [ + "project/ticket-*/user-*.md", + ".env", + "pyproject.toml", + "uv.lock" + ], + "stacks": [ + "python" + ], + "dependsOn": [ + "ticket-168" + ], + "conflictsWith": [], + "integrationTicket": null, + "delivery": { + "acceptedBaseSha": "bb2936452dcfae58b1665e677b8a4c66c20a7324", + "targetBranch": "main", + "outcome": "Adopt wellmanifest/docs standard in semcod/goal, add .governance/docs.json, link documentation in docs/README.md, and normalize evidence and section markers in docs/information/.", + "nonGoals": [ + "No runtime CLI interfaces modified", + "No existing documentation deleted" + ], + "complexity": "S", + "estimatedMinutes": 15, + "budgets": { + "maxImplementationFiles": 5, + "maxAffectedComponents": 2, + "maxPublicInterfaceChanges": 0, + "maxRuntimeDependencies": 0 + }, + "architecture": { + "status": "accepted", + "decision": "Pin wellmanifest/docs in .governance/docs.json, format docs/README.md and information docs to pass wellmanifest docs check.", + "components": [ + { + "name": "governance", + "paths": [ + ".governance/docs.json" + ] + }, + { + "name": "documentation", + "paths": [ + "docs/README.md", + "docs/information/adoption-command-adapter.md", + "docs/information/adoption-transactions.md" + ] + } + ], + "responsibilityChanges": false, + "interfaceChanges": [], + "dataChanges": [], + "ui": { + "impact": "none", + "states": [], + "evidence": [] + }, + "rollback": "Revert delivery commit." + }, + "runtimeDependencies": [], + "validation": [ + { + "criterion": "AC-03", + "commands": [ + "python3 \"$DOCS_STANDARD_ROOT/docs/standard/check.py\" --root . --standard-revision 19efafbeb18923cfd51cc69bd519330488500137" + ], + "evidence": "Docs check passes with ok: true" + }, + { + "criterion": "AC-04", + "commands": [ + "./project/governance-check.sh" + ], + "evidence": "Governance check passes cleanly" + } + ] + } +}