mattrothenberg/styleguide-boilerplate

A project to help Designers build living styleguides with Sass and Hologram.

styleguide-boilerplate's Issues

Create wiki?

should we create a wiki area? basically shorten the README and direct folks to wiki instead. Gives more ability to break down the styleguide. wiki could be broken down to:

1. Orientation
2. Deployment
3. Examples (I'm in the midst of using this to create my co's styleguide 👍 )
4. External Resources (links to Hologram, et al)
5. ??

this would keep only the Installation steps in the README - short & sweet. push back if this isn't a good idea, 🍺 infused Friday thoughts, thats all - 😁 .

Prescribe ruby version in Gemfile

We should prescribe the latest stable release.
ruby "2.3.1"

Release Versioning

Alert users if they are not on the latest release of styleguide-boilerplate

Using Github's API
ex: https://api.github.com/repos/mattrothenberg/styleguide-boilerplate/releases/latest

Psuedo
If tag_name in codebase != tag_name of latest
show div explaining that user is not on the latest release

Thoughts on using Github tags for an initial step towards versioning and creating releases?

Easy deploy?

@mattrothenberg @paulfarino should we add steps here to help designers get the styleguide up to a live URL?

Replace Bootstrap with BassCSS

I've gotten some feedback that it's confusing how some of the files in the styles directory, e.g., _alert.scss are empty, and yet components still get created when the styleguide is built.

This is because I'm pulling in Bootstrap via CDN in the styleguide-theme directory.

To that end, does it make more sense to replace Bootstrap with a library like BassCSS, where the majority of the components have to be rolled by hand? I think it would better illustrate the workflow we encourage Designers to take.