docs: fix docs build and render the callback diagram as themed mermaid#494
Merged
Conversation
An unquoted YAML frontmatter scalar cannot contain a colon-space, which broke the Astro build. Quote the value to keep the colon. Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
Replace the ASCII box diagram with a mermaid flowchart, and brand the mermaid node fill, border, and text to the cascade teal palette so the diagrams match the README rather than mermaid's default lavender. Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
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.
Problem
Two issues in the docs site, both from the recent refactor:
internals/architecture.md, which the Astro build rejects. This check is not a required gate, so it slipped through.reference/callbacks.mdstill carried an ASCII box-drawing diagram in a plain code fence, inconsistent with the mermaid diagrams the rest of the site uses. Its node boxes also rendered in mermaid's default lavender rather than the cascade palette.Fix
Verification
npm run buildsucceeds (23 pages). Rendered the callback page in a browser and confirmed node fill#0E8B82, border#36D0C4, and teal edges, with no default-lavender remaining. No box-drawing characters left in any page.