search

whoisryosuke / gatsby-documentation-starter

Automatically generate docs for React components using MDX, react-docgen, and GatsbyJS
https://gatsby-documentation-starter.netlify.com/
MIT License
91 stars 13 forks source link

Incorrect components source path #2

Closed teddybradford closed 6 years ago

teddybradford commented 6 years ago

When running the gatsby develop script on a fresh copy of this starter, the following error occurs:

The path passed to gatsby-source-filesystem does not exist on your file system:

../src/components/

Is the path supposed to be ./src/components/ (./ instead of ../)?

whoisryosuke commented 6 years ago

@teddybradford I designed this to work as a sub-repo inside of your project, such as a design system. Ideally, your project would be project_name > src > components and your docs would be project_name > docs.

You can see an example of this in my design system boilerplate, under the Gatsby docs branch..

If you'd like to change the source/component path, there's a section of the README that covers that 👍

teddybradford commented 6 years ago

Ah, okay! I didn't realize the intent for this to be a sub-repo, so I wanted to make sure that wasn't a typo.