Getting started flow is very buggy
See original GitHub issueBug Report
Describe the bug
The “Getting Started” process is super clunky and buggy.
The main issues is that you have to install a lot of dependencies by yourself (docz-theme-default
and @emotion/core
, for example), just to get it to run.
This is not a pure case of peerDependencies
.
If docz
requires these packages in order to run the very most basic setup, they should be installed as dependencies
.
And just when you think you’re done, another issue pops up and you have to scour the web/issues page for solutions, which often seem hacky (https://github.com/pedronauck/docz/issues/522 for example).
Besides that, the documentation doesn’t specify any of this, and it’s impossible to follow it step by step without running into these issues.
To Reproduce
- Install the latest version of
docz
(0.13.7
for example). - Run
docz dev
through an npm script. - See error.
This is just the latest error where I gave up:
./node_modules/@emotion/styled-base/dist/styled-base.browser.esm.js
Attempted import error: 'withCSSContext' is not exported from '@emotion/core'.
This is the before installing @emotion/core
myself:
./node_modules/docz-theme-default/dist/index.m.js
Attempted import error: 'ClassNames' is not exported from '@emotion/core'.
./node_modules/emotion-theming/dist/emotion-theming.browser.esm.js
Attempted import error: 'ThemeContext' is not exported from '@emotion/core'.
./node_modules/emotion-theming/dist/emotion-theming.browser.esm.js
Attempted import error: 'ThemeContext' is not exported from '@emotion/core'.
./node_modules/emotion-theming/dist/emotion-theming.browser.esm.js
Attempted import error: 'ThemeContext' is not exported from '@emotion/core'.
Expected behavior
Pretty straightforward:
- Up-to-date documentation.
- A package should install its dependencies.
Environment
- OS: MacOS
- Node/npm version: Node
8.9.0
, npm6.5.0
.
Issue Analytics
- State:
- Created 5 years ago
- Reactions:10
- Comments:6 (2 by maintainers)
Top GitHub Comments
I’m getting this problem today. I did try everything, included create a new project, but always is getting this warning and the project is not loading.
I’m using CRA but not using storybook. So i don’t see what is the problem.
docs are 2 months out of date. i’ve filed PR’s and just offered to help with maintaining. lets see if pedro accepts.