feat: auto-adjust markdown heading levels in design sections#26
Open
jeffutter wants to merge 1 commit intowedow:masterfrom
Open
feat: auto-adjust markdown heading levels in design sections#26jeffutter wants to merge 1 commit intowedow:masterfrom
jeffutter wants to merge 1 commit intowedow:masterfrom
Conversation
Design documents are often written as standalone markdown with h1/h2 top-level headings. Since tk nests design under `## Design`, these headings create improper structure (h1/h2 under h2 parent). This adds automatic heading adjustment: h1 → h3, h2 → h4, etc. Implementation: - New `adjust_design_headings()` function prepends ## to all headings - Applied in `cmd_create()` for --design flag - Applied in `cmd_migrate_beads()` during migration (awk tracks section) - Idempotent: already-adjusted or plain text content unchanged Why: Ensures proper markdown structure, allows natural authoring of design docs as standalone documents, fixes Beads migration output. All 114 test scenarios pass.
Nathan-Schwartz
added a commit
to Nathan-Schwartz/ticket
that referenced
this pull request
Mar 26, 2026
Design documents written as standalone markdown have h1/h2 headings that create improper nesting when placed under the ## Design section. This adds automatic heading adjustment: h1 becomes h3, h2 becomes h4, etc. Port of upstream PR wedow#26 (jeffutter).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Design documents are often written as standalone markdown with h1/h2 top-level headings. Since tk nests design under
## Design, these headings create improper structure (h1/h2 under h2 parent).This adds automatic heading adjustment: h1 → h3, h2 → h4, etc.
Implementation:
adjust_design_headings()function prepends ## to all headingscmd_create()for --design flagcmd_migrate_beads()during migration (awk tracks section)Why: Ensures proper markdown structure, allows natural authoring of design docs as standalone documents, fixes Beads migration output.
All 114 test scenarios pass.