docs: integrate mdbook-admonish and modernize documentation styling#43
Merged
Conversation
- Integrated 'mdbook-admonish' preprocessor for rich callouts. - Modernized CSS with Inter font, gradient headers, and refined UI components. - Optimized CI 'docs' job using 'jontze/action-mdbook' for faster builds. - Added informative note to Introduction page. - Validated build integrity with 'just docgen-check'.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the mdBook documentation pipeline and theme to support richer callouts (admonitions) and a refreshed visual style, while attempting to speed up the CI docs build.
Changes:
- Added
mdbook-admonishpreprocessor support and included its CSS in the HTML output. - Refreshed documentation styling (layout, headings, sidebar, tables, code blocks) and added a new intro callout.
- Switched CI docs setup to
jontze/action-mdbook@v3and added a customhead.hbsimporting Inter from Google Fonts.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| book/theme/rhai-live.css | Adds broader layout/typography/table/code styling on top of the existing Rhai live-editor theme CSS. |
| book/theme/mdbook-admonish.css | Introduces the mdbook-admonish stylesheet (icon + admonition component styling). |
| book/theme/head.hbs | Injects Inter via Google Fonts into the mdBook HTML head. |
| book/src/intro.md | Adds an admonish info callout to the Introduction. |
| book/book.toml | Registers the admonish preprocessor and includes its CSS in additional-css; updates preprocessor ordering. |
| .github/workflows/ci.yml | Replaces manual mdBook/mdbook-mermaid installs with jontze/action-mdbook@v3 in the docs job. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Refactored 3D rendering to use unique geometric volumes for each architectural idiom. - Implemented a tiered iconography inheritance system (Base Categories -> Specialized Roles). - Restored unique silhouettes for 'ingest' (Arrow), 'classify' (Pentagon), and 'reconcile' (Cross). - Enhanced text contrast with dark labels and high-visibility white halos. - Fixed emoji icon centering using mathematical SVG baselines. - Broadened semantic inference to cover comprehensive technical terminology in the book. - Cleaned up build artifacts and verified across all documentation chapters.
Member
Author
elasticdotventures
left a comment
elasticdotventures
left a comment
There was a problem hiding this comment.
Addressed the actionable feedback in this PR:
- removed external Google Fonts dependency from
book/theme/head.hbs(local-first docs rendering) - applied docs font stack to main content and restricted inline-code styling to avoid affecting fenced blocks
- scoped mdbook-admonish
summaryselectors to admonition titles only - updated
.github/workflows/ci.ymldocs job to run on PRs, installmdbook-admonish, and only deploy pages on push branches
Also revalidated the previously failing ledgerr-mcp contract_codegen test locally after regenerating MCP artifacts.
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.
This PR enhances the documentation visual style and optimizes the CI pipeline.
Changes: