Guard against space-titled admonitions (CI + CLAUDE.md) - #8
Merged
Merged
Conversation
Titled admonitions must use bracket syntax (:::tip[Title]) under the faster/mdx-rs pipeline; the space form renders as literal text. Add a CI lint step that fails the build if the space form reappears, and document the rule in CLAUDE.md so it doesn't regress. Co-Authored-By: Claude Opus 4.8 <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
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.
Why
Follow-up to #7. Titled admonitions must use the bracket form
:::tip[Title]because the faster/mdx-rspipeline doesn't recognize the legacy space form:::tip Title(it renders as literal:::text). This adds guardrails so it can't silently regress.Changes
.github/workflows/ci.yml): fails the build if any:::type Titlespace form appears indocs/, before the build step. Verified it ignores the bracket form and passes on the current clean docs.🤖 Generated with Claude Code