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

Consider unifying Storybook and docs #733

Open
dzucconi opened this issue Jul 20, 2020 · 2 comments
Open

Consider unifying Storybook and docs #733

dzucconi opened this issue Jul 20, 2020 · 2 comments

Comments

@dzucconi
Copy link
Member

The experience of trying to update the palette-docs is frustrating. No types, every change seems to trigger errors on compilation, changes randomly pop up the "Gatsby.js development 404 page" etc. All its dependencies are out of date and it's difficult to manage installs in palette from the root because installation of docs breaks. Most of the information surrounding process is no longer relevant, etc, etc.

One option we have here is to just upgrade to the new Story format and either write a custom wrapper that utilizes the exported stories, or just use Storybook + mdx docs to improve documentation from within storybook.

@damassi
Copy link
Member

damassi commented Jul 20, 2020

The experience of trying to update the palette-docs is frustrating. No types, every change seems to trigger errors on compilation, changes randomly pop up the "Gatsby.js development 404 page"

Maybe we should pair? The team has been working in these docs since 2019 with none of the problems that you've mentioned here. It's quite possible you're boothing things incorrectly, or misunderstand something in the toolchain.

That being said, storybooks does have a nice MDX feature now, and it would simplify things.

@damassi
Copy link
Member

damassi commented Jul 20, 2020

Pulling palette repo down, i noticed that common fsevents issue. Regenerated the lock file and yarn install --check-files and things installled as expected. yarn start then booted the docs as expected. Changes to palette are then picked up by gatsby.

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

No branches or pull requests

2 participants