Uninomicon

Documenting the dark corners of the Unity Engine.

User Tools

Site Tools


wiki:contributing

Contributor Guide

Thanks for the interest in contributing to the Uninomicon! Please read this page before adding information.

Mission Statement: The #1 risk to the Uninomicon is information becoming stale. Because of this, strive to write pages that are concise. Short text is vastly easier to edit. Favor lists rather than paragraphs when possible. Write like Wikipedia, not like a blog post.

What information should be here?

  1. This wiki is not a replacement for the Unity Docs. If a fact exists on the Unity Docs, it should not be on the Uninomicon.
  2. Pages should contain short-form information1). Use the fewest words you can to convey the point.
  3. Do not post long-form guides and tutorials. Instead, post these guides on a blog, and then create a link from the Uninomicon2).
  4. Favor facts and observations over tips and suggestions. 3)

Leave the Uninomicon cleaner than you found it!

  1. Follow the style of other pages! Use footnotes, headers, bullet points, and fold-outs. 4)
  2. Take a moment to tidy up the rest of the page, even if you're not editing the other sections.

Thanks for reading! I manually edit every change. Following these rules helps avoid extra work. If you're not sure about any of the above rules, don't hesitate to reach out to John Austin on Twitter.

1)
lists, short paragraphs, etc
2)
Long form text is a *big* maintenance burden, but it is easy to remove a link when it becomes out of date
3)
'Cookbook' style references are great, but become stale quickly as times change. The Unity Community Wiki is a better place for cook-book style recipes.
4)
Uninomicon does not use markdown, it uses a DokuWiki format. See the Syntax guide.
wiki/contributing.txt · Last modified: 2021/05/01 16:25 by 73.95.178.156