Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Updates for React Docgen #25776

Merged
merged 8 commits into from
Jan 31, 2024
Merged

Docs: Updates for React Docgen #25776

merged 8 commits into from
Jan 31, 2024

Conversation

jonniebigodes
Copy link
Contributor

Follows up on #24165, #24530, #25344

What I did

With this pull request, the documentation was updated to factor in the inclusion of react-docgen as the default React parser for ArgTypes and control inference.

What was done:

  • Documentation updates
    • TypeScript config API page is now conditionally rendered to showcase the relevant APIs for each framework supported
    • The controls page was updated to factor in this change and streamline the troubleshooting section that was previously added.
    • Other assorted pages were also updated to factor in this change, and some minor issues
    • Snippets were also updated and adjusted per this change

@shilman, I've assigned this pull request to you as well, so that this doesn't get forgotten, and we can work together in getting these changes available when possible. Let me know of any feedback you may have. Thanks in advance.

Checklist for Contributors

Testing

  1. Follow the steps in the contributing instructions for this branch, docs_react_ts_updates.
  2. Open the relevant documentation and verify the feature changes.

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Copy link
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

Nice work with all the conditional content!

Let me know how I can help get this across the line, or when it's ready for another review.

Copy link
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

Looks great!

@jonniebigodes jonniebigodes merged commit de6d3f5 into next Jan 31, 2024
18 checks passed
@jonniebigodes jonniebigodes deleted the docs_react_ts_updates branch January 31, 2024 17:24
@github-actions github-actions bot mentioned this pull request Jan 31, 2024
14 tasks
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.

4 participants