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

Documentation error #42

Open
codegaze opened this issue Apr 1, 2016 · 5 comments
Open

Documentation error #42

codegaze opened this issue Apr 1, 2016 · 5 comments

Comments

@codegaze
Copy link
Contributor

codegaze commented Apr 1, 2016

Hi @kumailht,

There might be a documentation error in the Read Only Information section.
You have an example with a 'read-only-information' class:

`


Product Specs

`

I think the correct class is 'flakes-information-box'.

@kumailht
Copy link
Owner

kumailht commented Apr 3, 2016

@codegaze Thank you for reporting this!

If you'd like to further contribute to the project, why not make a pull request?

@shayneoneill
Copy link

Where actually IS the documentation? The link on the site seems to just link to the repo for the site. But theres no documentation in there.

Or is the 'documentation' thing aspirational at this point?

@kumailht
Copy link
Owner

Documentation is at http://getflakes.com/preview/grid.html

@shayneoneill
Copy link

Excellent. you should probably fix the documentation link on the site. It currently points to the github for the site instead of the documentation.

@shayneoneill
Copy link

Its also a little incomplete. I couldn't find any documentation on whats supposed to be included, etc., The fact it can't be used out of the box, I think, due to needing a SASS compilation step, something I suspect most web devs never actually have had to do, means it needs more than the 3 lines i"DOwnload then look at the example" type instructions. It actually needs a guide on setting up the buildchain, etc. Took me a few hors to work that part out.

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

3 participants