-
-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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: Video coverage extended #23797
Conversation
docs/writing-docs/autodocs.md
Outdated
💡 Internally, Storybook uses a similar implementation to generate the default template. See the Doc Blocks [API reference](./doc-blocks.md#available-blocks) to learn more about how Doc Blocks work. | ||
|
||
</div> | ||
<YouTubeCallout id="q8SY4yyNE6Q" title="Custom Autodocs with Storybook 7 Docs Page | Quick Tips" /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When we include these at the page level, we place them immediately under the page title. The thinking there being that videos offer an alternative learning path, and we want to present that as early as possible.
I think we should apply the same pattern here, and place the YouTubeCallout immediately after the section heading.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know, and I thought of it as well, but I'm aware that users might want to get into the video upfront, but when taking a second look at it, I placed it there to give users the code first, and after it the video and the text so that they follow along what's being presented. More than ok with moving it up and seeing how it fares. If need be we can shift it around later on.
Sounds good?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is nice! I left a suggestion, but I'll go ahead and approve.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for taking this on João!
Cool to see that you were able to add the specific time stamps for the doc blocks!
Thank you both for the speedy review. Appreciate it 🙏 ! I've just addressed the suggestion, and let's see how it fares. Merging this in a bit after the frontpage one is merged in. |
What I did
Introduced some additional videos to complement the documentation further. Featured in this pull request are the following pages:
How to test
test_timestamps
branch on the frontpage repository.chore_docs_adds_videos
.@chantastic and @kylegach when you have a moment, can you take a look at this and let me know of any feedback? Thanks in advance.
Checklist
MIGRATION.MD
Maintainers
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
["cleanup", "BREAKING CHANGE", "feature request", "bug", "build", "documentation", "maintenance", "dependencies", "other"]
🦋 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>