Fix nested Markdown list indentation on the website - #276
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No unresolved review comments were identified, and the supplied assessments find it ready for approval.
Pull request overview
Fixes nested Markdown list indentation so child bullets render correctly in the MkDocs website.
Changes:
- Corrected nested lists across three guideline pages.
- Documented four-space indentation and local preview guidance.
File summaries
| File | Description |
|---|---|
docs/toolbox/version-control/gh-actions-runners.md |
Fixed nested action guidance indentation. |
docs/toolbox/guidelines/secret-scanning.md |
Fixed table of contents and nested guidance lists. |
docs/toolbox/guidelines/authn-authz.md |
Fixed nested authentication guidance lists. |
CONTRIBUTING.md |
Added Markdown indentation and preview guidance. |
Review details
- Files reviewed: 1/4 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
Fixes #239.
MkDocs uses Python-Markdown, which requires four spaces per nested list level. Two-space indentation accepted by GitHub was rendering child bullets as peers on the website.
CONTRIBUTING.md.Reviewed the other two-space matches; YAML examples and top-level list items were left unchanged. No parser or CSS changes are needed.
Validation
uv run --frozen mkdocs buildcompleted successfully using a temporary site output directory.git diff --checkpassed.The build reported existing missing-anchor links in the GHAS setup and secret-scanning pages; those are outside this indentation fix.