search

bitovi / documentcss

A documentation/guide portal for the Live Style Guide feature of DocumentJS
https://documentcss.com/
MIT License
72 stars 7 forks source link

Update repository description #49

Open leoj3n opened 7 years ago

leoj3n commented 7 years ago

I think this:

A documentation/guide portal for the Live Style Guide feature of DocumentJS

Would be more welcoming like this:

A website generator for the Live Style Guide feature of DocumentJS

leoj3n commented 7 years ago

I'm not sure that my suggested description is the most correct either. It's hard to describe exactly what this repo is in a couple words, which is part of the reason I think people get confused when they first find it. Perhaps something to do with lack of separation of concerns.

tomgreever commented 7 years ago

Considering our audience is mostly dev/designers, I think the most important thing to communicate is that it generates a live style guide. That it uses DocJS is secondary.

A Live Style Guide generator using DocumentJS.

adrifolio commented 7 years ago

I would use "Living" vs "Live" to keep it consistent with the website.