Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
whmii opened this issue Jul 10, 2016 · 3 comments
Open

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

whmii opened this issue Jul 10, 2016 · 3 comments

Comments

@whmii
Copy link
Contributor

whmii commented Jul 10, 2016

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
Copy link
Contributor

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

@tysongach
Copy link
Contributor

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
Copy link
Contributor Author

whmii commented Jul 14, 2016

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants