-
Notifications
You must be signed in to change notification settings - Fork 109
Contributing to the wiki
We appreciate that you'd like to contribute to our wiki! To keep things as organized and as accessible as possible we created a couple of rules that will help everyone to create, organize and acquire information.
We like to keep a simple and friendly tone on our wiki, always taking care with word casing for names (Dennis Richie) and acronyms (JSON). Code mentions are surrounded with the <code> tag (libsoletta) and code snippets should be surrounded by three backslashes and the language the snippet is written in, such as "```C":
int void main(void) {
return 0;
}Always add a short introductory text talking about everything that will be covered on the document before you dive deep into the content, this will help people understand what the document is about and what information they're going to get on it.
Always add links from the existing pages pointing to the one you just created whenever it makes sense.
Avoid creating pages that will only be accessible through the collapsed top-right menu, this will bury the page in a big list of pages.
When linking to another page always add some text before it explaining what it's about or it could very well look out of context.
Before removing any page ensure that the pages it links are also accessible through other pages to avoid that they are buried in the top right menu big list of pages.
If you find anything else that is important to the contributing process and it's still not here please contribute here!