Better documentation of elements about water.css HOT 29 OPEN

@kognise suggested an "inline html tutorial" style like Impress.js: #76 (comment)

I personally like the reference style of things like Bootstrap.

Reading more online, it sounds like there are four main types of documentation:

1. Tutorials
2. How-To Guides
3. Explanation
4. Reference

I can see the four above being:

1. A tutorial could be inline HTML like Impress.js or a separate page that walks through how to build an HTML page using water.css
2. A how-to guide is what we already have in both index.html and README.md, simple steps on how to install/use water.css
3. An explanation would be the motivation behind water.css that we provide in README.md and some of the background on the technical decisions we've made
4. A reference would be the Bootstrap style documentation

I think we need to expand more on both options 1 and 4.

Tutorial

I think this needs to be accessible and visible to users.

• We could inline HTML comments, but we would need to link to the source somehow from index.html.
• We could create a separate page (styled with water.css!) that had step by step code examples on how to use it

Reference

Like I said before, I like something like Bootstrap's documentation that provides a list of each component with code examples on how to use it.

Storybook would be an overkill way of doing this by generating documentation from code but it's interesting nonetheless. 🙂

from water.css.

can I work on this project?

from water.css.

@prasannabisen Go ahead! 😄

from water.css.

Hi! Is the project still open? If yes, can I work on this?

from water.css.

@kylejrp @prachi-28 @prasannabisen @kognise Anybody working on this right now? If not, I would like to try it.

from water.css.

I'm not sure if anyone has started working on this issue, but I'd love to review any WIP pull requests if you open them up. The "Tutorial" documentation should be a separate pull request from the "Reference" documentation I mentioned before. We can all collaborate once we have a starting point!

from water.css.

@kognise @kylejrp Is anybody working on this issue? If not, I would like to!!

from water.css.

Is the project still up? I would like to work upon it.

from water.css.

@kajal4329 sorry, got sent to my spam folder! It is, and feel free to!

from water.css.

@kognise On it.

from water.css.

is the project still up?

from water.css.

@mohitgoyal1234 yes, it is. I am working on it

from water.css.

/claim

from water.css.

Made progress on this in a50c8a0, more can be done however.

from water.css.

@kognise @kylejrp is this issue still open. I would like to contribute. also Tips and guidelines from people already working are appreciated.

from water.css.

Hello, is this project still open?? if yes ,I would love to work on this, and see if I can contribute to the project.
I am a first timer to contribute in open source...

from water.css.

Hey. The above issue has been closed.

from water.css.

Hello! Is this issue still open ? I would like to work on it.

from water.css.

hello is this issue still open??

from water.css.

is it working?

from water.css.

I believe that Improving documents like bootstrap can help many people to learn water.css faster and saves time for people who want to revise stuff in no time. Hey, is this still open? Can I contribute my services to water.css for documenting

from water.css.

can I do that

from water.css.

can you assign this issue to me?

from water.css.

I believe a project based learning or documentation would be better just like the freecodecamp one(responsive web design) would be best....Can i help

from water.css.

hey @kylejrp can you assign this issue to me. I am new and want to contribute very passionately .

from water.css.

Hey I wanted to contribute to this project, Can you assign this issue to me?

from water.css.

Is anyone working on this issue? Can I start workinng on it?

from water.css.

hi @kognise i am contributing in hacktoberfest if this issue is open could you please assign this to me

from water.css.

anyone working on it?? Cuz i would like to work on this right away!
.
.
.
.
.
.
.

from water.css.