Documentation of Framework

[aayusharora]

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

[monsij]

Can you please describe the requirements @aayusharora . Is a documentation required for the codebase?

[abhishek97]

@aayusharora Take a look at http://sassdoc.com/. The comment syntax is similar to JSDoc. See if we can use it.

[Yagya-Chaudhary]

could you please briefly describe the problem?

[thenamankumar]

VuePress is there.

[aayusharora]

@abhishek97 http://sassdoc.com/ looks cool, we can try this as well, Need to see what results it can produce.

[aayusharora]

@monsij @Yagya-Chaudhary @hereisnaman Updated the description, please follow up

[varadpoddar]

If still open, you can use docsify. It's fairly easy to set up and create documentation.