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.

Sign up for GitHub

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

Jump to bottom

Improve Spright documentation in Storybook and README #2099

Merged
merged 6 commits into from
May 14, 2024
Merged

Improve Spright documentation in Storybook and README #2099

merged 6 commits into from
May 14, 2024

Conversation

m-akinc
Copy link
Contributor

@m-akinc m-akinc commented May 10, 2024

Pull Request

🤨 Rationale

Part of #1979

👩‍💻 Implementation

  • added Doc page for Spright components in Storybook
  • added Doc page for Spright Tests in Storybook
  • updated Storybook intro page with mention of Spright
  • added component examples and Spright etymology to Spright README
  • moved all top-level Storybook documentation files from src/nimble/tests to src/docs
  • turned doc references to "nimble.ni.dev" into links to public storybook

🧪 Testing

Local build of Storybook.

✅ Checklist

  • I have updated the project documentation to reflect my changes or determined no changes are needed.

jattasNI
jattasNI approved these changes May 13, 2024
View reviewed changes
packages/storybook/src/docs/incubating.mdx Outdated Show resolved Hide resolved
rajsite
rajsite reviewed May 13, 2024
View reviewed changes
Copy link
Member

@rajsite rajsite left a comment

Choose a reason for hiding this comment

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

Looks good, just want to review the updated incubating section if included in this PR.

packages/storybook/src/docs/nimble-intro.mdx Outdated Show resolved Hide resolved
@m-akinc m-akinc requested a review from fredvisser as a code owner May 14, 2024 16:42
@m-akinc m-akinc requested a review from rajsite May 14, 2024 16:42
@rajsite rajsite enabled auto-merge (squash) May 14, 2024 22:56
@rajsite rajsite merged commit 8dbea36 into main May 14, 2024
11 checks passed
@rajsite rajsite deleted the users/makinc/spright-storybook-docs branch May 14, 2024 23:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jattasNI jattasNI jattasNI approved these changes

@rajsite rajsite rajsite approved these changes

@fredvisser fredvisser Awaiting requested review from fredvisser fredvisser is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@m-akinc @rajsite @jattasNI