-
Notifications
You must be signed in to change notification settings - Fork 8
Contribute to Documentation
Johny Georges edited this page Dec 2, 2017
·
1 revision
If you are looking to contribute to this Wiki, first off, thank you we really appreciate it.
Secondly, you will need to be aware of the formatting and style we use to write documentation.
if you want to display code, make sure to use codeblocks and specify the language you want to render,
Bad Formatting:
console.log("hello world")
Good Formatting
console.log("hello world");
When it comes to writing documentation, good examples can really help express your reasoning while also providing context, so feel free to provide examples to help get your point across.
Another thing that we must mention is the use of metaphors. Metaphors can be confusing if not conveyed in an effective and timely way so we just avoid them in general or use them sparingly.
That's it! Best of luck and thanks again!