[addon-docs] Previous/Next links in docs.

[folz]

Is your feature request related to a problem? Please describe.

I would like docs stories to link to their Previous and Next stories at either the top or bottom of the page.

I tried searching for variations of "storybook" "addon-docs" "previous next" "link", but wasn't able to find documentation that this feature already exists.

Describe the solution you'd like

Here is a screenshot from Docusaurus showing the ideal behavior:

For Storybook, given a sidebar of

• Guide
  • Getting Started
  • Installation
• Components
  • Button
  • Card

I would like the Guide|Installation docs to include

[ Previous                ]   [                Next ]
[ Guide - Getting Started ]   [ Components - Button ]

at either/both of the top and bottom of the docs.

Describe alternatives you've considered

Storybook supports linking to stories, so I could manually include the previous and next buttons for each docs story. However, this is manual and prone to becoming outdated. Ideally we would look at the storybook stories context, but I don't know enough about storybook's internals to know how to do this.

Are you able to assist bring the feature to reality?

Yes, if you can point me to the relevant code.

[shilman]

Hi @folz this would be an awesome example of a fairly simple docblock to write. I'm on the hook for documenting addon-docs as part of the 6.0 milestone, so once there's a dev guide it would be amazing if you could kick the tires on that and see how hard it is to implement this. I'd expect it shouldn't be too hard to extract this information automatically and create the links.

[folz]

For sure, that sounds good to me! Is there a place I can follow for updates to 6.0, or would you be able to tag me in this issue once that's released?

[shilman]

@folz absolutely. i'll tag you here when it's ready.

in terms of 6.0 here's a general issue (still basically empty): #9311

and for doc blocks documentation there isn't an issue yet. here's the closest thing to track #8379

[stale[bot]]

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 30 days. Thanks!

[shilman]

Converting this to a discussion. We’re reserving feature issues for things that are on our short-term roadmap. We’ll check back periodically to see whether this is a good candidate to be added. If this feature would be useful to you, please upvote!

[AngusMacrae]

This would be an excellent feature to add. We have implemented it in our codebase in a hacky way but a proper official DocBlock for it would be great.