Add markdown formatting rules for coaching_state.md writes#42
Open
christophecapel wants to merge 1 commit intonoamseg:mainfrom
Open
Add markdown formatting rules for coaching_state.md writes#42christophecapel wants to merge 1 commit intonoamseg:mainfrom
christophecapel wants to merge 1 commit intonoamseg:mainfrom
Conversation
…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>
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
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.
Summary
</details>, table separator rows, and proper<details>nestingContext
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
🤖 Generated with Claude Code