fix(docs): add metadata to protocol overview diagrams - #1889
Open
Osraka wants to merge 1 commit into
Open
Conversation
Collaborator
🟡 Heimdall Review Status
|
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
2 participants
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.
What changed? Why?
Adds descriptive titles and the required
lines wrap expandablemetadata to the eight Mermaid diagrams on the canonical Base Protocol overview page.The same metadata was added to the legacy
specs/protocol/overview.mdxpage in #1883. After #1867 moved that content tospecs/overview.mdx, the canonical page still had bare Mermaid fences, so the changed-file style check reported 16 errors. This reuses the already-approved metadata from the legacy page.Notes to reviewers
This only changes the eight opening fence lines. Diagram content, links, navigation, and page structure are unchanged.
How has it been tested?
node scripts/lint-mdx.js docs/base-chain/specs/overview.mdx(0 errors)node scripts/lint-mdx.js all --check-nav(466 files, 0 errors)npm test(80 passed)node scripts/validate-docs-structure.jsgit diff --check