Repository navigation
Render readable Mermaid diagrams in the documentation - #9
Merged
Merged
Conversation
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.
The product lifecycle and AS-IS handoff guides show Mermaid source instead of diagrams. Register the custom SuperFences fence so Material renders them through its native Mermaid runtime. Keep the diagram content and change the layout to readable vertical flows, including the AS-IS fork on phones.
Browser checks enumerate every Mermaid page, inspect actual SVGs through Material's shadow roots, and cover light/dark appearance, theme changes, instant navigation, history and mobile widths. Run the fixture builder through the managed documentation environment so it uses the installed MkDocs rather than a system Python without it. The image-readiness helper visits each lazy image and checks its selected source and native dimensions before decoding it.
Validation: final
make docs-checkpassed the strict build, discovery of 53 pages/cards, static checks, 15 Python checks and all 39 browser cases. Native diagram labels passed the 12-pixel minimum and current desktop/phone captures were inspected. Previous gallery failures and the system-Python fixture failure are retained in private qualification evidence; no browser assertions or image-loading attributes were weakened. This documentation fix does not publish the separate software candidate.