docs: capture list-spacing best practice and surface solutions/#19
Open
mairas wants to merge 1 commit into
Open
docs: capture list-spacing best practice and surface solutions/#19mairas wants to merge 1 commit into
mairas wants to merge 1 commit into
Conversation
Document the Python-Markdown blank-line-before-lists requirement that caused #18, and add a pointer from CLAUDE.md so future agents discover the solutions/ knowledge store and the rule itself before authoring new content. Co-Authored-By: Claude Opus 4.7 (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
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
Follow-up to #18. Captures the Python-Markdown blank-line-before-lists requirement as a reusable knowledge doc so the rule and the underlying mechanism don't have to be rediscovered next time.
Changes
solutions/best-practices/markdown-lists-need-blank-line-2026-05-16.md— knowledge-track doc explaining why MkDocs/Python-Markdown folds lists into the preceding paragraph without a blank line, with before/after examples and a note on thesane_listsalternative we chose not to enable.solutions/lives outsidedocs/so it doesn't ship to the published site.mkdocs build --strictis unaffected.CLAUDE.md— added the list-spacing rule to Content Guidelines (catches it at authoring time) and a short "Engineering Notes" section pointing atsolutions/so future agents can discover the knowledge store.Test plan
uv run mkdocs build --strictpasses (solutions/ is not in docs_dir)🤖 Generated with Claude Code