Add section-aware docs OG images#295
Open
BrianSeong99 wants to merge 1 commit into
Open
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.
Summary
Adds section-aware Open Graph / Twitter preview images for docs pages so shared links keep page-specific title/description metadata while showing a useful section image instead of the same global fallback everywhere.
Closes #294.
What changed
/next, and versioned docs paths.DocItem/Metadataso normal docs pages use explicit frontmatter images when present, otherwise inherit the nearest section image.DocCategoryGeneratedIndexPageso generated category pages also get section images.static/img/og/.npm run generate:ogto regenerate the image set from a single script.img/og/miden-docs.png.Verification
npm run generate:oggit diff --checkstatic/img/og/NODE_OPTIONS=--max-old-space-size=12288 npm run buildafter local deploy-style ingestion of external docs/next/builder/tools/clients/react-sdk/query-hooks/→ page title/description +react-sdk.png/builder/tools/clients/react-sdk/query-hooks/→ page title/description +react-sdk.png/builder/smart-contracts/accounts/→ generated category title +smart-contract-accounts.png/next/builder/tools/note-transport/users/→ page title/description +note-transport.pngNotes
The full build still reports existing broken-link, broken-anchor, KaTeX, and Browserslist warnings unrelated to this change.
npm run typecheckalso still reports pre-existing Docusaurus alias/type errors in swizzled and versioned theme files; the new files do not appear in the filtered typecheck output.