Wanted to have a quick discussion on this so we know how to architect the website going forwards.
NOTE: docs for packages I think should live in the packages themselves. This is about system docs, primarily tutorials and guides (but also maybe
Docs exist in a
My original intended future state
All docs files get moved into appropriate folders in the website (where a tutorials folder currently exists)
My new plan
This content will be way easier to navigate on github if it just continues to live in
The website doesn't really care where it pulls info from, as long as the place it pulls from is consistent.
The text was updated successfully, but these errors were encountered:
I think something like this would be nice:
├── README.md # can contain front-matter; pulled in by docz ├── LICENSE ├── package.json # scope: `@keystone/*` │ ├── src/ │ ├── index.js # only for exports │ ├── ThingX.js │ ├── ThingY.js │ └── util.js │ ├── docs/ # when dynamic examples are needed; pulled in by docz │ ├── thing1.mdx │ └── thing2.mdx │ └── docs.mdx # maybe an entire directory is too much?
I guess the shape doesn't really matter; but I definitely have a preference for the docs to live with component/package/lib. Guides and tutorials can be wherever, probably