Uninomicon

Documenting the dark corners of the Unity Engine.

User Tools

Site Tools


wiki:contributing

This is an old revision of the document!


Contributor Guide

Thanks for the interest in contributing to the Uninomicon! Please read this page before adding information, so that I don't have to re-edit your submission.

What Information Should be Here?

  1. Ordered List Item This wiki is not a replacement for the Unity Documentation; it is a supplement. If a fact exists on the Unity Docs, it should not be on the Uninomicon1).
  2. Pages should contain short-form information2). It should be easy to skim when you are researching a problem. Please write with the fewest words you can.
  3. Do not post long-form guides and tutorials. Instead, post these guides on a blog, and then create a link on from the Uninomicon3).

Leave the Uninomicon cleaner than you found it!

  1. Follow the style of other pages! Use headers, bullet points, and fold-outs to keep things tidy 4)
  2. Keep in mind the readability of the page, and add headers/organization as necessary, even if they weren't there before.
  3. Write concisely! Use the fewest words you can to convey the point. Your readers will thank you. 5) Thanks for reading! I manually oversee every edit, so following these rules helps avoid extra work on me. If you're not sure about any of the above rules, don't hesitate to me on Twitter.
1)
The shorter the Uninomicon is, the easier it is to skim
2)
lists, short paragraphs, etc
3)
Long form text is a *big* maintenance burden, but it is easy to remove a link when it becomes out of date
4)
Uninomicon does not use markdown, it uses a DokuWiki format. See the Syntax guide.
5)
Avoid filler words and phrases such as “In this case” “Also”, “It also means that”.
  1. Proof-read! Check for grammar, spelling, etc ((If you're not a native English speaker, use a grammar checker like Google Docs, etc
wiki/contributing.1619798605.txt.gz · Last modified: 2021/04/30 16:03 by uninomiconadmin