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

posible use of a tool to document i.e. sassdoc #150

Closed
area73 opened this issue Aug 26, 2016 · 3 comments
Closed

posible use of a tool to document i.e. sassdoc #150

area73 opened this issue Aug 26, 2016 · 3 comments

Comments

@area73
Copy link

area73 commented Aug 26, 2016

Have you consider the use of a tool to generate docs for sass files like sassdoc ?

@csshugs
Copy link
Member

csshugs commented Aug 29, 2016

@area73
IMO sassdoc would be an overhead because we have very little Sass functionality which needs documentation. Apart from that we would have to completely change our commenting style 😞

In a custom, large scale project, sassdoc surely proves itself useful, especially when there are more developers involved. But since inuitcss is third-party code in such projects, I don't see any need to document the framework code itself with sassdoc. As framework user, everything you'll need to know about inuitcss will be provided on the documentation site when it's done.

@florianbouvot
Copy link
Member

@csshugs I agree with you 😉

@csshugs
Copy link
Member

csshugs commented Aug 31, 2016

Maybe we change our minds in the future. But for now, I close this.

But thanks @area73 for bringing this up!

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

No branches or pull requests

3 participants