Skip to content

Add markdown formatting rules for coaching_state.md writes#42

Open
christophecapel wants to merge 1 commit intonoamseg:mainfrom
christophecapel:fix/markdown-formatting-rules
Open

Add markdown formatting rules for coaching_state.md writes#42
christophecapel wants to merge 1 commit intonoamseg:mainfrom
christophecapel:fix/markdown-formatting-rules

Conversation

@christophecapel
Copy link
Copy Markdown

Summary

  • Adds a "Markdown Formatting Rules" section under State Update Triggers in SKILL.md
  • Enforces blank lines before headings, blank lines after </details>, table separator rows, and proper <details> nesting
  • Prevents a class of formatting bugs where AI-generated markdown renders correctly in some parsers but breaks on GitHub's strict CommonMark

Context

Discovered multiple rendering issues in a coaching_state.md file caused by incremental AI writes that omitted blank lines before headings, missed table separator rows, and placed nested <details> blocks as siblings instead of children. These rules codify the fix as a mechanism rather than relying on the AI to remember.

Test plan

  • Verify the new section appears under State Update Triggers in SKILL.md
  • Run a coaching session that writes to coaching_state.md and confirm the output follows the formatting rules
  • Check coaching_state.md renders correctly on GitHub Preview after a session

🤖 Generated with Claude Code

…ring issues

Adds a "Markdown Formatting Rules" section under State Update Triggers that enforces:
- Blank lines before ## and ### headings (CommonMark requirement)
- Blank lines after </details> closing tags
- Table separator rows after every table header
- Proper nesting of <details> blocks within parent toggles

These rules prevent a class of formatting bugs where AI-generated markdown
renders correctly in some parsers but breaks on GitHub's strict CommonMark.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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.

1 participant