Skip to content

Comments

docs: add video recording showcasing changesets for atoms#24220

Merged
Ryukemeister merged 1 commit intomainfrom
rajiv/cal-6015-docs-add-video-recording-showcasing-changesets-for-atoms
Oct 2, 2025
Merged

docs: add video recording showcasing changesets for atoms#24220
Ryukemeister merged 1 commit intomainfrom
rajiv/cal-6015-docs-add-video-recording-showcasing-changesets-for-atoms

Conversation

@Ryukemeister
Copy link
Contributor

No description provided.

@linear
Copy link

linear bot commented Oct 2, 2025

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 2, 2025

Walkthrough

This 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)
Check name Status Explanation Resolution
Description Check ⚠️ Warning No pull request description was provided, so there is no context or summary of the documentation addition and navigation update introduced in this PR. Please add a pull request description that summarizes the new documentation page with its embedded video and the corresponding navigation entry in docs/mint.json to give reviewers clear context for this change.
✅ Passed checks (2 passed)
Check name Status Explanation
Title Check ✅ Passed The title clearly specifies that a video recording showcasing changesets for atoms is being added to the docs, which aligns with the embedded Loom video included in the new guide page and follows conventional commit syntax for documentation updates.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch rajiv/cal-6015-docs-add-video-recording-showcasing-changesets-for-atoms

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@keithwillcode keithwillcode added core area: core, team members only platform Anything related to our platform plan labels Oct 2, 2025
@graphite-app graphite-app bot requested a review from a team October 2, 2025 11:22
@dosubot dosubot bot added the docs area: docs, documentation, cal.com/docs label Oct 2, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between 96468c4 and bc3e2b0.

📒 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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

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).

Copy link
Contributor

@supalarry supalarry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really clear and helpful video - thank you!

@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2025

E2E results are ready!

@Ryukemeister Ryukemeister merged commit a1ac5f3 into main Oct 2, 2025
125 of 132 checks passed
@Ryukemeister Ryukemeister deleted the rajiv/cal-6015-docs-add-video-recording-showcasing-changesets-for-atoms branch October 2, 2025 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core area: core, team members only docs area: docs, documentation, cal.com/docs platform Anything related to our platform plan ready-for-e2e size/S

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants