fix: Resolve MkDocs build failures in strict mode#976
Merged
Conversation
- Create missing docs/design/INDEX.md referenced in mkdocs.yml nav - Fix nested code fences in landing-page-strategy.md causing sections 6 and 7 to be rendered inside code blocks instead of as proper headings The nested ```bash block inside section 5.5's outer ``` block was causing parsing issues. Using 4 backticks for the outer block allows proper nesting. Co-Authored-By: Claude Sonnet 4.5 <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.
Summary
docs/design/INDEX.mdreferenced inmkdocs.ymlnav configurationdocs/design/landing-page-strategy.mdthat caused sections 6 and 7 to be rendered inside code blocks instead of as proper headingsDetails
Issue 1: Missing INDEX.md
The
mkdocs.ymlnav configuration referenceddesign/INDEX.mdwhich did not exist, causing a warning that aborted the build in strict mode.Issue 2: Broken anchor links
The Table of Contents in
landing-page-strategy.mdhad links to#6-copy-suggestionsand#7-wireframe-concepts, but these anchors did not exist in the generated HTML.Root cause: Section 5.5 contained a nested code block (
```bashinside```). Standard markdown doesn't support nested code fences with the same delimiter. The inner```was prematurely closing the outer block, causing all subsequent content (including sections 6 and 7) to be parsed incorrectly.Fix: Changed the outer code fence in section 5.5 to use 4 backticks (
````) which properly allows the inner 3-backtick code block to be nested.Test plan
mkdocs build --strictlocally - passes without warnings or errors#6-copy-suggestionsand#7-wireframe-conceptsexist in generated HTMLGenerated with Claude Code