feat: add docs links to examples and examples links to docs#3182
Draft
gabrielmfern wants to merge 4 commits intocanaryfrom
Draft
feat: add docs links to examples and examples links to docs#3182gabrielmfern wants to merge 4 commits intocanaryfrom
gabrielmfern wants to merge 4 commits intocanaryfrom
Conversation
- Create README.md in packages/editor/examples with a table of all examples, linking each to its source file and corresponding docs page - Add 'Examples' sections to editor docs pages (overview, getting-started, bubble-menu, slash-commands, theming, styling, buttons, column-layouts, link-editing, email-export, custom-extensions) linking to relevant runnable examples on GitHub Co-authored-by: Gabriel Miranda <gabrielmfern@outlook.com>
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Contributor
|
This review could not be run because your cubic account has exceeded the monthly review limit. If you need help restoring access, please contact contact@cubic.dev. |
commit: |
cursor
bot
changed the title
Update all cross-links in docs and README to point to the hosted examples website at editor-examples.react.email with hash-based routes (e.g., #bubble-menu, #full-email-builder) instead of raw GitHub source file URLs. Co-authored-by: Gabriel Miranda <gabrielmfern@outlook.com>
gabrielmfern
changed the title
- Add docsUrl field to ExampleItem interface and populate it for all 14 examples, pointing to the relevant docs page on react.email - Show a 'Docs' link with external-link icon in the top-right of each example's main content area, linking to that example's docs page - Add a 'Documentation' link in the sidebar footer linking to the editor overview page Co-authored-by: Gabriel Miranda <gabrielmfern@outlook.com>
Break long SVG and path attributes onto separate lines to satisfy the Biome formatter, and wrap a long assignment in app.tsx. Co-authored-by: Gabriel Miranda <gabrielmfern@outlook.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
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.
Summary
Adds bidirectional cross-links between
packages/editor/examplesand the editor documentation inapps/docs.Changes
New file:
packages/editor/examples/README.mdUpdated: Examples website (
packages/editor/examples/src)Added documentation links throughout the examples website:
index.ts— AddeddocsUrlfield toExampleIteminterface; populated for all 14 examplesapp.tsx— Shows a "Docs" link (with external-link icon) in the top-right of each example, linking to the relevant docs pagesidebar.tsx— Added a "Documentation" link in the sidebar footer linking to the editor overviewUpdated: Editor documentation pages (11 files)
Added an "Examples" section with
CardGrouplinks to the relevant runnable examples at editor-examples.react.email:editor/overview.mdxeditor/getting-started.mdxeditor/features/bubble-menu.mdxeditor/features/slash-commands.mdxeditor/features/theming.mdxeditor/features/styling.mdxeditor/features/buttons.mdxeditor/features/column-layouts.mdxeditor/features/link-editing.mdxeditor/features/email-export.mdxeditor/advanced/custom-extensions.mdxWhy
Makes it easier for developers to navigate between documentation and working code. Reading docs? Jump straight to a runnable example. Browsing examples? Find the full documentation for the feature being demonstrated.
Summary by cubic
Adds bidirectional links between the editor docs and the live examples site so readers can jump between guidance and runnable demos. Each example also links back to its docs for quick reference.
New Features
packages/editor/examples/README.mdlisting 14 examples with links to live demos, source, related docs, and local run steps.apps/docswith an Examples section linking to hosted demos; featured links ineditor/overviewandeditor/getting-started.docsUrlfor all 14 examples, a top-right Docs link per example, and a sidebar Documentation link.Bug Fixes
Written for commit ed155c0. Summary will update on new commits.