coding-blocks / coding-blocks/motley
Documentation of Framework
- Dominant language
- SCSS
- Stars
- 26
- Forks
- 47
- PR merge metrics
- No merged PRs in 30d
Description
Propose the best way to document this framework.
The codebase is split up into two major layers
elements: They are independent skeleton that are used to make objects
objects: They are the combination of elements along with the layer of layouting
**PS: Some of the elements do not require to be used as an object, hence they should also be documented.**
There is an approach needed to document each and every object/element that is complete in itself.
For example:
Documenting a card means:
[ HTML Code + CSS code ] represented in a well defined UI, so that anyone can use that card ( i.e making it reusable )
There should be a static page that can document each of our complete elements/objects.
- [ ] Propose a way to document Motley elements/objects
- [ ] Document the cards and buttons element/objects
For reference:
Check how the element section of semantic-ui is documented
https://semantic-ui.com/elements/button.html
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the Semantic UI elements documentation linked in the issue and the distinction between Motley elements and objects. Propose a static documentation approach, then document the cards and buttons with reusable HTML/CSS examples; done means the approach is specified and those elements have complete standalone pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- scss
- Domain
- documentation, frontend
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100