Fix docs formatting for mkdocs rendering#95
Merged
thomas-bartlett merged 1 commit intomainfrom Jan 27, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the MkDocs configuration and custom rules documentation so that the "Custom Rules" page is visible in the navigation and renders correctly in MkDocs/Material, with better list-nested code blocks and a more compact frontmatter schema table.
Changes:
- Add the
Custom Rulespage to the MkDocs navigation so it appears in the site sidebar. - Reformat the Quick Start section code examples in
docs/custom-rules.mdto use indented code blocks that nest correctly under ordered list items. - Simplify and align the frontmatter schema table, shortening the
tagsdescription and pointing readers tosrc/tag_mappings.pyto avoid column wrapping.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
mkdocs.yml |
Adds a Custom Rules entry to the navigation, wiring the new/updated documentation page into the docs site. |
docs/custom-rules.md |
Adjusts Markdown formatting (indented code blocks and table alignment/wording) for correct MkDocs rendering and clearer linkage to the tag mappings source. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ramraaj25
approved these changes
Jan 26, 2026
Collaborator
ramraaj25
left a comment
There was a problem hiding this comment.
Looks good to me! Thanks
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.
Fixes table and code block formatting issues in the custom rules documentation. Uses indented code blocks for proper list nesting and shortens table content to prevent column wrapping.