WTFM (Write the fucking manual!) - Githubissues

buildit / gravity-ui-web

Library of styles, components and associated assets to build UIs for the web. Part of buildit's Gravity design system.

http://style.buildit.digital/

MIT License

20 stars 6 forks source link

WTFM (Write the fucking manual!) #180

Open james-nash opened 5 years ago

james-nash commented 5 years ago

Now that more Buildsters want to use Gravity, it's high time we start writing some instructions. E.g.:

How to get started (ways to use the code, where to get it, maybe boilerplate projects or generators?)
How to migrate existing sites / apps to Gravity
Process to add new components or update new ones (maybe we can adopt a flowchart like Canonical's one: http://atomicdesign.bradfrost.com/chapter-5/#making-changes-to-patterns )
Examples: Our pattern library's templates and pages are currently a (crappy) replica of our website. We should change that and have a more interesting collection of (inspirational?) examples

Related: #119

james-nash commented 5 years ago

@marcospeebles - if/when you start writing Gravity docs, you can assign yourself to this issue :-)