docs: add video recording showcasing changesets for atoms#24220
Conversation
WalkthroughThis PR adds a new documentation page: docs/developing/guides/atoms/add-changesets.mdx titled "Add changesets," describing how to add a changeset to PRs affecting atoms and embedding a Loom video walkthrough. It also updates docs/mint.json to introduce a new Guides subgroup "Atoms" with icon "atom" and includes the page developing/guides/atoms/add-changesets in its navigation. No existing documentation files are modified or removed, and there are no changes to exported or public code entities. Possibly related PRs
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
docs/developing/guides/atoms/add-changesets.mdx(1 hunks)docs/mint.json(1 hunks)
⏰ Context from checks skipped due to timeout of 180000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Install dependencies / Yarn install & cache
|
|
||
| We use changesets for every PR that affects atoms, be it a fix or feature to add a log describing the fix or feature. Below video showcases how to add a changeset to a PR. | ||
|
|
||
| <iframe style={{ width: "100%", maxWidth: "560px" }} height="315" src="https://www.loom.com/embed/2130c801b35248f6b878eb531eb62184?sid=0e2fe07b-59d4-4f31-beb0-7f267154de8b" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen="true"></iframe> |
There was a problem hiding this comment.
Fix iframe prop casing for JSX compatibility
In MDX/JSX, these iframe props must be camelCased (frameBorder, allowFullScreen, referrerPolicy). Leaving them lowercase throws TS/JSX type errors and fails the docs build. Please update the attribute names.
🤖 Prompt for AI Agents
In docs/developing/guides/atoms/add-changesets.mdx around line 7, the iframe
uses lowercase HTML attributes which cause TS/JSX type errors in MDX; update the
attribute names to their JSX camelCase equivalents by changing frameborder to
frameBorder, allowfullscreen to allowFullScreen, and referrerpolicy to
referrerPolicy (leave other props like style, width, height, src, title, allow
as-is).
supalarry
left a comment
There was a problem hiding this comment.
Really clear and helpful video - thank you!
E2E results are ready! |
No description provided.