Writing docs section migration for 6 0 #11654
Conversation
jonniebigodes
changed the title
docs/writing-docs/introduction.md
Outdated
| In both cases, you’ll use [Doc Blocks](./docs-blocks) as the building blocks to create full featured documentation. | ||
|
|
||
| <div style="background-color:#F8FAFC"> | ||
| TODO: ask tom if this is the proper place for the advanced |
There was a problem hiding this comment.
@jonniebigodes the advanced readme is going to live in the monorepo as an .md file.
Probably at addons/docs/ADVANCED-README.md. (Does that sound right @shilman?)
I think we probably just need to put an absolute link down (i.e. "https://github.com/storybookjs/storybook/...") although it'd be nice to be able to use a relative link somehow ("../../addons/docs/...") so the link worked if you view this MD file on GH directly.
docs/writing-docs/mdx.md
Outdated
| If you don't define stories in your MDX, you can write MDX documentation and associate it with an existing story, or embed that MDX as its own documentation node in your Storybook's navigation. | ||
|
|
||
| <div style="background-color:#F8FAFC"> | ||
| TODO: ask tom about the "CSF Stories with MDX Docs" link if that's where it should be pointing |
There was a problem hiding this comment.
This is the section. I'm not sure where this will be located after the re-org. In ADVANCED.md? recipes.md? Someplace in the official docs?
There was a problem hiding this comment.
I guess this didn't make it to these docs after all huh?. WDYT @shilman?
There was a problem hiding this comment.
Sorry I missed this. I think recipes could be its own chapter in the "Writing Docs" section, after "Doc Blocks". WDYT?
There was a problem hiding this comment.
Sure, that could make sense. OTOH I think we had previously decided not to include them, and perhaps to have a RECIPES.md file in the addon. I don't have a strong opinion either way.
docs/writing-docs/doc-blocks.md
Outdated
| TODO: ask tom about both links below to where they should point to. | ||
| </div> | ||
|
|
||
| Also, custom [addons] can provide their own doc blocks, and there are [many available]. |
There was a problem hiding this comment.
many available => not yet published doc blocks blog post I think. (@domyen when is that going to be published?)
There was a problem hiding this comment.
Let's add this after 6.0 is released
There was a problem hiding this comment.
Removed the link, took a note of it and once Storybook 6 lands i'll update the docs accordingly.
docs/writing-docs/doc-blocks.md
Outdated
| #### DocsPage | ||
|
|
||
| <div style="background-color:#F8FAFC"> | ||
| TODO: left it for now ask feedback tom/shillman on this based on [pr](https://github.com/storybookjs/storybook/issues/11441) |
There was a problem hiding this comment.
Not implemented--fell off the radar. I'll add it this week.
docs/writing-docs/doc-blocks.md
Outdated
| TODO: ask tom/michael about the preview iframe. as we've been calling it canvas so far and now move to preview. | ||
| And also inline rendering support location |
There was a problem hiding this comment.
@shilman -- should we rename the Preview docblock to Canvas? I feel like that would probably make sense.
The inline rendering link would be the "Inline stories vs. Iframe stories" in the earlier docs-page file
There was a problem hiding this comment.
I can get behind Canvas.
Documented here: #11696
Will make the change once the docs are composed and everybody's happy with the new naming.
There was a problem hiding this comment.
There are a lot of other points where we should start calling it canvas too.
|
This is ready to merge from my end. @jonniebigodes is making a spreadsheet that track straggler todos across all of the new docs. That way we can tackle them in a follow up PR after this is merged. |
|
Merging as is. Subsequent changes will be made into follow up pull requests. |
This pull request addresses the migration of the writing docs section to version 6.0 of the docs.
What was done.
Feel free to provide feedback