Repository navigation
docs: illustrate bundled help guides and render Markdown examples - #800
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
1 participant
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
Rewrite all four bundled help guides with numbered illustrations, task-oriented instructions, navigation cards, and Markdown source/result examples. Examples use isolated, read-only editor previews so they match document rendering, including math and diagrams. Bundled illustrations adapt to the application theme and remain readable in GitHub Markdown.
Document the help authoring conventions and add coverage for guide links, trusted illustrations, preview lifecycle, and responsive layouts.
Related Issue
Closes #788
Verification
Focused help and editor tests cover source/result cards, trusted illustration handling, internal navigation, guide links, and read-only preview rendering and cleanup.
pnpm check:frontendandgit diff --checkpassed.Manually verified in a local Vite browser preview on Windows:
Not verified: desktop E2E was added for all four guides in light/dark appearance at narrow/wide widths and is left to CI. Maintainer visual approval of every guide in those configurations remains pending.