Skip to content

Docs: Align documentation with CSF v3#26621

Merged
jonniebigodes merged 5 commits into
storybookjs:nextfrom
nkabrown:docs-csf-v3
Mar 25, 2024
Merged

Docs: Align documentation with CSF v3#26621
jonniebigodes merged 5 commits into
storybookjs:nextfrom
nkabrown:docs-csf-v3

Conversation

@nkabrown
Copy link
Copy Markdown
Contributor

  • CSF v3 component examples are story objects not story functions
  • add missing punctuation mark

What I did

This PR updates some areas in the documentation that still described stories as functions (CSF v2) instead of objects (CSF v3). This PR will require a 'documentation' label.

* CSF v3 component examples are story objects not story functions
* add missing punctuation mark
@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented Mar 22, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 9733666. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@nkabrown nkabrown changed the title Align documentation with CSF v3 Docs: Align documentation with CSF v3 Mar 22, 2024
@jonniebigodes jonniebigodes self-assigned this Mar 22, 2024
Copy link
Copy Markdown
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.

@nkabrown, thanks for putting together this pull request and helping us improve the documentation by catching these regressions that were introduced into our documentation. We appreciate it 🙏 !

Left a small item for you to look into when you have a moment.

Let me know once you've addressed it and I'll be more than glad to get this in and published into the documentation.

Have a fantastic day.

Stay safe

Comment thread docs/writing-stories/index.md Outdated
@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels Mar 24, 2024
@nkabrown
Copy link
Copy Markdown
Contributor Author

@jonniebigodes thanks for the suggestion. This is resolved.

@nkabrown nkabrown requested a review from jonniebigodes March 25, 2024 13:36
@jonniebigodes
Copy link
Copy Markdown
Contributor

@nkabrown no need to thank whatsoever, glad to help. Thanks for addressing the feedback so promptly. All is good on my end and going to merge this once the checklist clears.

Have a great day.

Stay safe

@jonniebigodes jonniebigodes merged commit 09be01b into storybookjs:next Mar 25, 2024
storybook-bot pushed a commit that referenced this pull request Mar 25, 2024
Docs: Align documentation with CSF v3
(cherry picked from commit 09be01b)
storybook-bot pushed a commit that referenced this pull request Mar 25, 2024
Docs: Align documentation with CSF v3
(cherry picked from commit 09be01b)
storybook-bot pushed a commit that referenced this pull request Mar 26, 2024
Docs: Align documentation with CSF v3
(cherry picked from commit 09be01b)
storybook-bot pushed a commit that referenced this pull request Mar 26, 2024
Docs: Align documentation with CSF v3
(cherry picked from commit 09be01b)
storybook-bot pushed a commit that referenced this pull request Mar 26, 2024
Docs: Align documentation with CSF v3
(cherry picked from commit 09be01b)
storybook-bot pushed a commit that referenced this pull request Mar 26, 2024
Docs: Align documentation with CSF v3
(cherry picked from commit 09be01b)
storybook-bot pushed a commit that referenced this pull request Mar 26, 2024
Docs: Align documentation with CSF v3
(cherry picked from commit 09be01b)
storybook-bot pushed a commit that referenced this pull request Mar 26, 2024
Docs: Align documentation with CSF v3
(cherry picked from commit 09be01b)
@github-actions github-actions Bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Mar 28, 2024
@ndelangen ndelangen removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Oct 28, 2025
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 patch:done Patch/release PRs already cherry-picked to main/release branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants