Skip to content

Fix docs formatting for mkdocs rendering#95

Merged
thomas-bartlett merged 1 commit intomainfrom
fix/docs-formatting
Jan 27, 2026
Merged

Fix docs formatting for mkdocs rendering#95
thomas-bartlett merged 1 commit intomainfrom
fix/docs-formatting

Conversation

@thomas-bartlett
Copy link
Collaborator

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.

@thomas-bartlett thomas-bartlett self-assigned this Jan 26, 2026
Copilot AI review requested due to automatic review settings January 26, 2026 14:57
@thomas-bartlett thomas-bartlett added the documentation Improvements or additions to documentation label Jan 26, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Rules page to the MkDocs navigation so it appears in the site sidebar.
  • Reformat the Quick Start section code examples in docs/custom-rules.md to use indented code blocks that nest correctly under ordered list items.
  • Simplify and align the frontmatter schema table, shortening the tags description and pointing readers to src/tag_mappings.py to 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.

Copy link
Collaborator

@ramraaj25 ramraaj25 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! Thanks

@thomas-bartlett thomas-bartlett merged commit 60b0fe5 into main Jan 27, 2026
9 checks passed
@thomas-bartlett thomas-bartlett deleted the fix/docs-formatting branch January 27, 2026 13:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants