Storybook: Versioned Documentation

Created on 26 Jun 2017  路  6Comments  路  Source: storybookjs/storybook

why

We need a way to document preview releases of storybook. We may also want docs for people using old versions.

what

  • [ ] Docs for a preview release, clearly labeled as preview with disclaimers and pointers to the main docs
  • [ ] Docs for the latest stable release of Storybook, statically hosted at https://storybook.js.org
  • [ ] Docs for previous minor releases of Storybook, with disclaimers and pointers to the main docs
documentation feature request help wanted todo

Most helpful comment

As @Hypnosphi describes, this issue has become:
We need a method for users to be able to select an older version of the docs.
We can use netlify links for that purpose. But it needs a UI & links on the docs.

All 6 comments

You all are moving fast. It would be nice (on the readme.md at statement about upgrading. I have had a fair share of problems with configuring and installing storybook. Now that I have it working. I am afraid to upgrade the cli. Fortunately, Im only using storybook on a ui test app. I found it easier reinstall storybook, start a new project, then copy over the stories. It looks like you are posting new releases ever few days. The version I have works fine. I'd like to keep up with the changes. After more than a year, I've finally gotten storybook to work for me. THANKS!

@smoojitter All of the releases since 3.0 have been backwards compatible unless we messed up. Whenever we make changes that require modifications on your side, we have been updating MIGRATION.md. But we'll do a better job documenting the changes and all suggestions are welcome. Thanks!

is this still a valid issue @Hypnosphi @ndelangen? wouldn't we be able to deploy branch builds to netlify for each release and keep them versioned?

We already do, but we haven't any links to them anywhere
E.g. docs for current alpha (master) https://storybooks.netlify.com/

As @Hypnosphi describes, this issue has become:
We need a method for users to be able to select an older version of the docs.
We can use netlify links for that purpose. But it needs a UI & links on the docs.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

arunoda picture arunoda  路  3Comments

shilman picture shilman  路  3Comments

tirli picture tirli  路  3Comments

levithomason picture levithomason  路  3Comments

miljan-aleksic picture miljan-aleksic  路  3Comments