kognise/water.css

Better documentation of elements

Open

#80 opened on May 25, 2019

View on GitHub
 (29 comments) (0 reactions) (0 assignees)CSS (8,627 stars) (498 forks)batch import
enhancementgood first issue

Description

#76 brought up the point that it's difficult for new HTML users to understand how to use some of the more complicated HTML elements.

I'd love to see index.html (or maybe a separate page) have some sections on how to use each of the elements water.css supports. For example, documentation for the blockquote element could be:

Blockquote

Documentation

Example usage:

<blockquote cite="https://www.huxley.net/bnw/four.html">
    <p>Words can be like X-rays, if you use them properly – they'll go through anything. You read and you're pierced.</p>
    <footer>
        <cite>– Aldous Huxley, Brave New World</cite>
    </footer>
</blockquote>

Demo:

There would be a few parts to this issue:

  1. Discussion on what the content documentation should contain?
  2. Discussion on what the documentation should look like visually?
  3. Writing of the html for this documentation

This is a lot of work to do, so any help on this issue is very appreciated!

Contributor guide

Tech stack
htmlcss
Domain
documentationfrontend
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic HTML and CSS knowledgeFamiliarity with Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Start by reading the full discussion in issue #80 and related issue #76 to understand the existing concerns and suggestions. Open the index.html file in the repository to see current documentation structure. Follow the example provided for blockquote to create similar sections for all supported HTML elements (e.g., <form>, <table>, <button>, etc.). Consider using a consistent format with a heading, a link to MDN documentation, example code, and a live demo. Discuss any design decisions on visual presentation in the issue before implementing. Finally, submit a pull request with the updated index.html.