Skip to content

docs(storybook): remove blank line inside RichTextEditorAutoLinkPlugin @example - #4848

Open
josephfarina wants to merge 1 commit into
mainfrom
navi/docs/storybook-compat-0810
Open

docs(storybook): remove blank line inside RichTextEditorAutoLinkPlugin @example#4848
josephfarina wants to merge 1 commit into
mainfrom
navi/docs/storybook-compat-0810

Conversation

@josephfarina

Copy link
Copy Markdown
Contributor

What

The @example block in RichTextEditorAutoLinkPlugin.tsx had a blank line between the import statement and the JSX inside the code fence. Storybook's markdown renderer can interpret a blank line as ending the code fence, which makes the rest of the example render as raw text instead of code. Removed the blank line so the import and JSX stay in one contiguous block.

No behavior change; JSDoc comment whitespace only.

Checklist

  • pnpm --filter @astryxdesign/core typecheck:docs passes
  • tsc --project packages/cli/tsconfig.template-docs.json --noEmit passes
  • No blank lines, JS comments, or bare > inside the @example code block
  • Single concise @example

Notes for reviewers

Two related Storybook @example issues were found but deferred to avoid conflicts with open PRs:


Night Watch — Doc Reviewer

…@example

A blank line between the import and the JSX inside the @example code fence
can end the code block early in Storybook's markdown renderer, causing the
rest of the example to render as raw text. Remove it so the block stays
contiguous.

Found during Night Watch doc review.
@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Meta Open Source bot. label Aug 10, 2026
@vercel

vercel Bot commented Aug 10, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
astryx Ignored Ignored Aug 10, 2026 9:19am

Request Review

@github-actions

Copy link
Copy Markdown
Contributor

PR Analysis Report

📚 Storybook Preview

View Storybook for this PR
GitHub Pages may take up to a minute to hydrate after deploy.

🧪 Sandbox Preview

View Sandbox for this PR
GitHub Pages may take up to a minute to hydrate after deploy.

Modified Components

RichTextEditor (@astryxdesign/lab) · View in Storybook
Metric Before After Delta
Bundle Size (ESM) N/A N/A N/A
Lines of Code N/A 1576 -
Complexity N/A Very High (103) -

Bundle Size Summary

Package Size (ESM) Size (CJS) Gzipped
@astryxdesign/lab N/A 3.7KB 1.6KB

Accessibility Audit

Status: No accessibility violations detected.


Generated by PR Enrichment workflow | Storybook | Sandbox | View full report

github-actions Bot added a commit that referenced this pull request Aug 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant