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

Inconsistency in content of storybook docs pages #977

Open
wheresrhys opened this issue Jan 26, 2023 · 1 comment
Open

Inconsistency in content of storybook docs pages #977

wheresrhys opened this issue Jan 26, 2023 · 1 comment
Projects

Comments

@wheresrhys
Copy link
Contributor

e.g. within buttons, Grouped buttons and pagination just feature their own demos:

image

whereas all the standalone buttons appear together on a single docs page

image

Maybe this is a feature rather than a bug, but I wonder if it can be improved because e.g. it's jarring at the moment that clicking o-buttons -> docs persents a very limited set of docs for the component, covering just the 'grouped buttons' use case

@origamiserviceuser origamiserviceuser added this to Backlog in Origami ✨ Jan 26, 2023
@notlee
Copy link
Contributor

notlee commented Jan 26, 2023

Storybook is very much a WIP and the docs page isn't something we've curated at all, except for trialling mdx in o-loading. It's mostly generated by Storybook and isn't particularly helpful, especially when props show those that are there for demo purposes only.

Figuring out an ideal information hierarchy is something we should do this quarter whilst evaluating how we document components. The README is our main source of documentation currently, mostly technical (how) with a smattering of design/usage guidelines (where, why). If we want to write more of the latter, how does that fit with the readme? Carbon keeps code / usage guidelines in separate tabs. GDS have a more integrated structure with inline demos and code, I favour that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Origami ✨
  
Backlog
Development

No branches or pull requests

2 participants