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 the addon documentation #23246

Merged
merged 10 commits into from
Jul 3, 2023
Merged

Conversation

jonniebigodes
Copy link
Contributor

With this pull request the create addons & writing presets documentation was updated to reflect the recent updates to Storybook, effectively consolidating the addon documentation in a single place for better maintenance.

What was done:

  • Updated the writing addons documentation based on the tutorial
  • Updated the required snippets/assets to factor in the item above
  • Updated the writing presets documentation
  • Fixed incorrect links in the documentation

@integrayshaun and @ndelangen can both of you take a pass at this and follow up with me on any feedback that you may have? Let me know and we'll go from there.

@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch labels Jun 28, 2023
@jonniebigodes jonniebigodes self-assigned this Jun 28, 2023
@jonniebigodes jonniebigodes changed the title Chore: (Docs) Updates for the addon documentation Docs Updates for the addon documentation Jun 28, 2023
@jonniebigodes jonniebigodes changed the title Docs Updates for the addon documentation Docs: Updates for the addon documentation Jun 28, 2023
Copy link
Contributor

@ShaunEvening ShaunEvening 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, João! Just a few comments in the files.

Also, can we add pnpm as an option in the shell snippets?

docs/addons/addon-types.md Outdated Show resolved Hide resolved
docs/addons/addons-api.md Outdated Show resolved Hide resolved
docs/addons/integration-catalog.md Outdated Show resolved Hide resolved
@ndelangen
Copy link
Member

@jonniebigodes Is there a easy to digest preview URL I can take a look at, making this easier to review?

@jonniebigodes
Copy link
Contributor Author

@ndelangen at this stage no, but if you're ok with it, you can follow the steps in the contributing instructions for this branch, chore_docs_addon_changes and let me know of any feedback

@jonniebigodes
Copy link
Contributor Author

That's a fantastic suggestion @integrayshaun already added the pnpm variants.

@jonniebigodes jonniebigodes merged commit e053703 into next Jul 3, 2023
16 of 17 checks passed
@jonniebigodes jonniebigodes deleted the chore_docs_addon_changes branch July 3, 2023 12:00
JReinhold pushed a commit that referenced this pull request Jul 3, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
JReinhold pushed a commit that referenced this pull request Jul 3, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
JReinhold pushed a commit that referenced this pull request Jul 4, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
JReinhold pushed a commit that referenced this pull request Jul 4, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
JReinhold pushed a commit that referenced this pull request Jul 4, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
JReinhold pushed a commit that referenced this pull request Jul 4, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
JReinhold pushed a commit that referenced this pull request Jul 4, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
JReinhold pushed a commit that referenced this pull request Jul 4, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
JReinhold pushed a commit that referenced this pull request Jul 4, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
JReinhold pushed a commit that referenced this pull request Jul 4, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
JReinhold pushed a commit that referenced this pull request Jul 4, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
JReinhold pushed a commit that referenced this pull request Jul 4, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
JReinhold pushed a commit that referenced this pull request Jul 4, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
JReinhold pushed a commit that referenced this pull request Jul 4, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
JReinhold pushed a commit that referenced this pull request Jul 4, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
JReinhold pushed a commit that referenced this pull request Jul 4, 2023
Docs: Updates for the addon documentation
(cherry picked from commit e053703)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jul 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants