Lack of Documentation

[mateeyow]

Might I suggest a proper documentation in using your framework just like bootstrap and foundation, I think it will be easier for us developers to use your framework when you have better documentation. Thank you!

[speakman]

I second this. I really like the look of Bootflat but having a hard time using it because of the lack of documentation.

[nomadcrypto]

I second this too. I would also like access to the javascript sources as well. I have a lot of experince with bootstrap so I was able to get the project moving along nicely but certain things keep hanging me up and they are all related to the javascript used.

[dhasilin]

I second this too.

[hitchcockwill]

Yep, came here to add an issue like this.

Another suggestion for an easy improvement would be to not minify the HTML on the documentation page. At the very least, it would make it a lot easier to inspect the source.

[mojowill]

Guys what documentation do you want? You should be referring to the Bootstrap documentation on most things, BootFlat is simply a UI kit that alters the appearance of standard Bootstrap elements, for other BootFlat specific stuff there are examples on the website, why not simply "Inspect Element"?

👎

[DerDu]

@hitchcockwill If you use e.g Chrome and Inspect Element it got the little"{}" button to reformate the source code for good reading...

I would like a documentation of the missing parts not in Bootstrap but added by BootFlat e.g the footer .. thats all

[nomadcrypto]

The lack of unminifed sources and documentation for those unminifed sources makes it hard to work with. Having either 100% of unminified sources available or proper documentation for those sources is what is needed to make this usable for a real world project.

[tdeck]

+1 to this. I really like the way Bootflat looks, and I would love to start using it, but as I dig deeper I've really become frustrated by how there are no docs for anything at all. I understand that most of this stuff is the same for ordinary Bootstrap, but there are some things that seem to be Bootflat specific as mentioned above. One good example is the color theming which appears to be heavily featured on the Bootlfat website, but I can't find a simple way to change the colors - I assume the right answer isn't to just drop to raw CSS.

[mallim]

if bootflat can be structured something like bootswatch (https://bootswatch.com/), it will also be quite easy to understand in terms of the customization done to boostrap.

[les113]

Documentation? Do you really think this http://bootflat.github.io/documentation.html passes for documentation?

[rhssk]

I agree that the documentation leaves something to be desired. Maybe add source code (HTML, JS) for each of the elements in http://bootflat.github.io/documentation.html? In my opinion it should be a quick reference (https://designmodo.github.io/Flat-UI/docs/components.html is a good example). Now you have to inspect page source, filter out the extras and go hunting documentation for each of the used tools (iCheck etc).

[nomadcrypto]

i requested this documentation several years ago before I knew what I know now about css, html, less, etc. Now I wouldn't need it like I did then but overall proper documentation is always nice. I do like the UI in bootflat but now there are several alternatives which have decent documentation. An example is adminlte - https://github.com/almasaeed2010/AdminLTE

…

On Mon, Feb 25, 2019 at 1:36 AM shayneoneill ***@***.***> wrote: Seconding this. We've got a getting started that tells you to download it (kinda obvious, but ok), and doesn't tell us how to get started. And a documentation thats a demo but has no documentation. Even just some indication of what files in that big ol' ball of stuff we're supposed to use would go a long way. — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#63 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AJBuvFujj1vWkz2IZts4v-m3Qe1gJQTlks5vQ8q-gaJpZM4CzFYz> .