Skip to content

Conversation

@Harshit-Mourya
Copy link
Contributor

@Harshit-Mourya Harshit-Mourya commented Jan 3, 2026

This PR replaces informal wording with standard terminology across documentation files for improved clarity and consistency.

No functional changes.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Refined wording for improved clarity and consistency in framework documentation.

✏️ Tip: You can customize this high-level summary in your review settings.

@jonniebigodes jonniebigodes self-assigned this Jan 3, 2026
@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. labels Jan 5, 2026
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@Harshit-Mourya, thanks for taking the time to put together this pull request and helping us improve the documentation by catching this small typo and fixing it. Appreciate it 🙏 !

I've checked, and everything is good on my end. I will merge this once the checklist is cleared.

Hope you have a great day.

Stay safe

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 5, 2026

📝 Walkthrough

Walkthrough

Two documentation files are updated to correct wording from "automagically" to "automatically" in the DocsPage feature description within the Docs tab documentation sections.

Changes

Cohort / File(s) Summary
Documentation wording corrections
code/addons/docs/docs/frameworks/COMMON.md, code/addons/docs/docs/frameworks/REACT.md
Changed "automagically" to "automatically" in DocsPage section text describing documentation availability for all stories under the Docs tab.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes


📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1d114bc and fae5613.

📒 Files selected for processing (2)
  • code/addons/docs/docs/frameworks/COMMON.md
  • code/addons/docs/docs/frameworks/REACT.md
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{js,jsx,ts,tsx,json,md,html,css,scss}

📄 CodeRabbit inference engine (.github/copilot-instructions.md)

Format code using Prettier with yarn prettier --write <file>

Files:

  • code/addons/docs/docs/frameworks/REACT.md
  • code/addons/docs/docs/frameworks/COMMON.md
🧠 Learnings (3)
📚 Learning: 2025-12-22T22:03:40.123Z
Learnt from: CR
Repo: storybookjs/storybook PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-12-22T22:03:40.123Z
Learning: Applies to {code/addons,code/frameworks}/**/README.md : Update README files for significant changes and include code examples in addon/framework documentation

Applied to files:

  • code/addons/docs/docs/frameworks/REACT.md
  • code/addons/docs/docs/frameworks/COMMON.md
📚 Learning: 2025-11-05T09:38:47.712Z
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32458
File: code/core/src/components/components/Select/Select.tsx:200-204
Timestamp: 2025-11-05T09:38:47.712Z
Learning: Repo: storybookjs/storybook — Guidance: Until Storybook 11 is released, do not suggest using React.useId anywhere (e.g., in code/core/src/components/components/Select/Select.tsx) to maintain compatibility with React 17 runtimes. Prefer advising: accept a caller-provided props.id and, if needed, generate a client-only fallback id to minimize SSR hydration issues — but avoid useId. Resume prompting for useId after Storybook 11.

Applied to files:

  • code/addons/docs/docs/frameworks/REACT.md
📚 Learning: 2025-10-01T15:24:01.060Z
Learnt from: Sidnioulz
Repo: storybookjs/storybook PR: 32594
File: code/core/src/components/components/Popover/WithPopover.tsx:7-9
Timestamp: 2025-10-01T15:24:01.060Z
Learning: In the Storybook repository, "react-aria-components/patched-dist/*" (e.g., "react-aria-components/patched-dist/Dialog", "react-aria-components/patched-dist/Popover", "react-aria-components/patched-dist/Tooltip") are valid import paths created by a patch applied to the react-aria-components package. These imports should not be flagged as broken or invalid until a maintainer explicitly states they are no longer acceptable.

Applied to files:

  • code/addons/docs/docs/frameworks/REACT.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: get-branch
🔇 Additional comments (2)
code/addons/docs/docs/frameworks/COMMON.md (1)

31-31: ✓ Clear wording improvement.

Replacing "automagically" with "automatically" improves clarity and consistency with standard technical documentation terminology.

code/addons/docs/docs/frameworks/REACT.md (1)

40-40: ✓ Consistent wording improvement across framework docs.

Replacing "automagically" with "automatically" maintains consistency with the same improvement in COMMON.md and aligns the documentation with standard technical terminology.


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.

@jonniebigodes jonniebigodes changed the title Docs/improve docs wording Docs: Fix framework typos Jan 5, 2026
@jonniebigodes jonniebigodes merged commit 190bbe4 into storybookjs:next Jan 5, 2026
14 of 21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants