Skip to content

fix(ce-plan): render Implementation Units as headings, not bulleted list items#766

Open
pvinis wants to merge 2 commits intoEveryInc:mainfrom
pvinis:fix-ce-plan-units-rendering
Open

fix(ce-plan): render Implementation Units as headings, not bulleted list items#766
pvinis wants to merge 2 commits intoEveryInc:mainfrom
pvinis:fix-ce-plan-units-rendering

Conversation

@pvinis
Copy link
Copy Markdown

@pvinis pvinis commented May 4, 2026

Closes #765.

Why

The current Implementation Units template formats each unit as - U1. **[Name]** with **Goal:**, **Files:**, etc. at the document root. Under CommonMark, flush-left content after a blank line ends the list item, so:

  • Each unit becomes its own one-item list.
  • The **Goal:** / **Files:** / **Approach:** paragraphs that should be unit children float at the root between lists.
  • Multi-unit plans render as a disconnected wall of bold paragraphs in GitHub, VS Code preview, Proof, and any strict CommonMark renderer.

Issue #765 has a fuller before/after example.

What changes

  • Template at line 653: - U1. **[Name]** becomes ### U1. [Name].
  • Phase 3.5 prose at line 399 updated to reflect the heading format and explain why list-based unit titles break.

Why headings, not indented bullets

Indenting all sub-content under each bullet would also fix rendering, but headings are the right semantic match for sections containing multi-block content, survive future edits without re-indenting, and provide anchor links for navigation and cross-reference.

Compatibility

  • U-IDs unchanged: ### U1. [Name] preserves the stable identifier.
  • ce-work parses U-ID prefixes (ce-work/SKILL.md:118), not list structure, so task derivation is unaffected.
  • No effect on ce-plan deepening or ce-doc-review workflows.

Verification

Generated a sample plan from the updated template and rendered it in GitHub and VS Code preview; each unit appears as a navigable section with its sub-content correctly grouped underneath.

…ist items

The current template formats each unit as `- U1. **[Name]**` with
`**Goal:**`, `**Files:**`, etc. at the document root. Under CommonMark,
flush-left content after a blank line terminates the list item, so each
unit becomes its own one-item list and the per-unit fields float at the
document root with no visible parent. Multi-unit plans render as a flat
wall of bold paragraphs in GitHub, VS Code preview, Proof, and any
strict CommonMark renderer.

Switch unit titles to level-3 headings (`### U1. [Name]`). Headings are
the right semantic match for sections containing multi-block content,
render correctly everywhere, and provide anchor links. U-IDs stay
stable, and ce-work parses U-ID prefixes (ce-work/SKILL.md:118) rather
than list structure, so task derivation is unaffected.

Closes EveryInc#765
Copy link
Copy Markdown
Collaborator

@tmchow tmchow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Heads-up on a downstream consumer this PR's audit missed: ce-code-review/SKILL.md:377 still describes units as list items.

If a plan is found, read its Requirements section … plus Implementation Units (items listed under the ## Implementation Units section).

After this change, units are ### U1. subsections, not bullets. A literal reader can scan under the H2 for - … lines, find nothing, and silently skip Stage 6's Requirements Completeness check for every unit (ce-code-review/SKILL.md:604).

Suggested tweak in the same line:

…plus Implementation Units (subsections ### U1, ### U2, … under the ## Implementation Units section).

The other Implementation Units references I checked are safe:

  • ce-work / ce-work-beta — parse U3: prefix from task subjects, format-agnostic (as the PR description notes).
  • ce-doc-review/SKILL.md:84,90 and ce-adversarial-document-reviewer.agent.md — only count units to gate persona activation; counting subsections works the same as counting bullets.
  • ce-plan/references/{deepening-workflow,synthesis-summary,visual-communication,universal-planning}.md and ce-doc-review/references/review-output-template.md — prose mentions only, no structural extraction.

@pvinis
Copy link
Copy Markdown
Author

pvinis commented May 5, 2026

Thanks for the comment. Pushed some more things :).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ce-plan Implementation Units template breaks markdown rendering

2 participants