Skip to content

Commit 5f1efd4

Browse files
committed
spec: approve 2026-04-17-extract-inline-code-snippets-from-docs
1 parent fae6d9a commit 5f1efd4

1 file changed

Lines changed: 5 additions & 12 deletions

File tree

specs/2026-04-17-extract-inline-code-snippets-from-docs.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ The following criteria apply **per utility PR**.
152152
5. Update the markdown: replace inline blocks with `--8<-- "..."` includes, normalize language tags to `csharp`, recalculate `hl_lines`.
153153
6. Verify: run `mkdocs build --strict` and visually inspect in local dev server.
154154

155-
### PR Order and Branch Names (ascending complexity)
155+
### PR Order (ascending complexity)
156156

157157
| # | Utility | Branch Name |
158158
|---|---------|-------------|
@@ -166,8 +166,6 @@ The following criteria apply **per utility PR**.
166166
| 8 | Kafka | `docs/extract-kafka-snippets` |
167167
| 9 | Logging | `docs/extract-logging-snippets` |
168168

169-
Branch naming pattern: `docs/extract-<utility>-snippets`, where `<utility>` matches the snippet directory name.
170-
171169
### Include Syntax Example
172170

173171
**Before:**
@@ -232,7 +230,7 @@ Branch naming pattern: `docs/extract-<utility>-snippets`, where `<utility>` matc
232230

233231
- **Strategy**: Strictly one PR per utility, merged independently. Each PR touches only one markdown file and creates one snippet directory. Start with smallest (metadata) to build confidence, end with largest (logging).
234232
- **Sub-issues**: Create one sub-issue per utility under parent issue #794.
235-
- **Branch per PR**: Each PR on its own branch from `develop`, following the pattern `docs/extract-<utility>-snippets` (see PR Order and Branch Names table above).
233+
- **Branch per PR**: Each PR on its own branch from `develop`. Branch naming follows `docs/extract-<utility>-snippets` (see PR Order table for exact names).
236234
- **No cross-PR dependencies**: Any merge order works.
237235
- **Rollback**: `git revert` per utility PR restores the inline code blocks.
238236

@@ -243,12 +241,7 @@ Branch naming pattern: `docs/extract-<utility>-snippets`, where `<utility>` matc
243241
- Reason: reviewer feedback
244242
- **Addressed (2026-04-18)**: Strengthened per-utility delivery constraint in three places: (1) Intent section — added explicit paragraph making one-PR-per-utility a hard constraint with rationale, (2) AC-16 — reinforced that each PR is scoped to exactly one utility, (3) Rollout strategy — added "strictly" qualifier and scope clarification.
245243

246-
### AMD-002 (2026-04-18) — Reviewer: @reviewer
247-
- Clarification on "independent PR": Should define in this document the branch names for each pr
248-
- Reason: reviewer feedback
249-
- **Addressed (2026-04-18)**: Added "PR Order and Branch Names" table to Implementation Approach with explicit branch names for all 9 utilities following pattern `docs/extract-<utility>-snippets`. Updated Rollout section to reference the table.
250-
251-
### AMD-003 (2026-04-18) — Reviewer: @reviewer
252-
- Clarification on "independent PR": the names of the branches should be in the document.
244+
### AMD-002 (2026-04-19) — Reviewer: @reviewer
245+
- Clarification on "independent PR": I want to have the branch names in this docuemtn for each pr
253246
- Reason: reviewer feedback
254-
- **Addressed (2026-04-18)**: Same as AMD-002 — both amendments requested branch names, addressed together.
247+
- **Addressed (2026-04-19)**: Added explicit branch names for all 9 PRs. (1) PR Order section — replaced numbered list with table including Branch Name column using `docs/extract-<utility>-snippets` convention, (2) Rollout section — added branch naming reference to the "Branch per PR" bullet.

0 commit comments

Comments
 (0)