Documentation - Githubissues

cloudfour / drizzle

A streamlined tool for developing, documenting and presenting UI pattern libraries.

https://cloudfour.com/thinks/introducing-drizzle/

MIT License

666 stars 32 forks source link

Documentation #31

Open tylersticka opened 8 years ago

tylersticka commented 8 years ago

We need more. 😁

[ ] Update this issue description with more specific to-dos

erikjung commented 8 years ago

Fabricator's docs are a good example to measure against: http://fbrctr.github.io/

megnotarte commented 8 years ago

Large.

megnotarte commented 8 years ago

Initially, we could include the docs in GitHub. In the future, we could create a separate site.

megnotarte commented 8 years ago

@nicolemors @tylersticka Can you both start by providing some information about what would be helpful with getting started? @saralohr if you want to install and give it a go that works

tylersticka commented 8 years ago

Just riffing on what I'd ask if I were a designer-developer new to the project...

What is Drizzle? What does it do?
How do I start using it? (Download, clone, installation)
How are things structured?
- Patterns
- Pages
- Templates
- Available helpers
Where do assets live?
What can I customize?
Examples
- Style guide
- Prototype sandbox
Where can I go for help, to contribute, etc.?

Two partially related but possible out-of-scope ideas:

It might be nice to have a video walkthrough at some point.
If this is even possible, it'd be swell to have a little Electron app for clients or participants who want to use Drizzle but are scared of the Terminal.

gerardo-rodriguez commented 8 years ago

Which type of structure (Patterns, Pages, Templates) can use Front Matter? (Note: This can be found in the drizzle-builder repo, but would a new user know to look there?

saralohr commented 8 years ago

When I was messing around with the Drizzle logo, it wasn't immediately apparent to me that all classes are namespaced with drizzle, since they do not appear that way in the CSS files. It took me looking at the compiled drizzle.css to figure out why the classes I applied were having no effect. This could be a good tidbit for the "Customizing Drizzle" section.

gerardo-rodriguez commented 8 years ago

Where do assets live?

Where does my JS go?

If it is a sandbox/prototype, should my JS go somewhere specific?

If it is JS for a component/pattern, where does that go?

Any suggested patterns to follow?

edouard-lopez commented 6 years ago

Nice works guys, do you plan to update the documentation?