search

thoughtbot / bourbon.io

This is the source code for the Bourbon website
https://www.bourbon.io/
MIT License
17 stars 8 forks source link

Move $bourbon; to the top of the list. #22

Open whmii opened 8 years ago

whmii commented 8 years ago

I think it would be good have the first section be the docs for the $bourbon settings variable (I mean, until we add some installation instructions sections). Right now it is kind of buried.

I think we should have a section for 'settings' and then what ever we decide for the res of them, 'Functions and Mixins'? ¯(ツ)/¯

tysongach commented 8 years ago

Currently they are simply ordered by source order, which is how SassDoc parses the comments.

tysongach commented 8 years ago

My thinking was that the easiest thing right now is to just let it output as-is, as SassDoc outputs the JSON. Later we can group and manipulate.

I think a similar issue is that the title bourbon doesn’t really help for this specific doc item. A title more like Bourbon Settings or just Settings would help a lot.

SassDoc supports @group and @name.

whmii commented 8 years ago

Yea, I agree that something like Bourbon Settings would be more clear but we can just hold this off to later.