Skip to content
Julian Gonggrijp edited this page May 7, 2013 · 5 revisions

The Red Spider Project wiki is still very young. Here's how you can help out.

Table of Contents

Click on a red link

This will bring you straight to a form for creating the missing page.

... or create a new page

That's also fine, if you can think of a topic that needs to be covered and doesn't have a name yet!

Use edit mode "MediaWiki"

In the topright corner of the editing form you find a drop-down menu that lets you pick an edit mode. The default is (GitHub-flavored) Markdown. MediaWiki is however more convenient; see below how within-wiki links are created in both syntaxes.

Markdown:

 [Home](https://github.com/the-xkcd-community/the-red-spider-project/wiki)

MediaWiki (without the space between the brackets):

 [ [Home]]

You can find a reference of the MediaWiki syntax here.

Content and cross-linking

It doesn't really matter how you how you structure your article, the only thing of importance is that wiki pages answer relevant questions that people are likely to ask. Being clear and concise is more important than being complete or detailed. It's probably good to create many links to related information. A "See also" section can be a nice touch on some pages.

Always do a preview

Because things may look different from what you had in mind.

How to decide whether to link to your page from Home

Not all pages need to have a direct link from Home. Consider whether the topic is as general and of as central importance as the other topics linked from Home. If unsure, just do whatever comes to your mind first; if somebody disagrees with your choice they can always change it.

Don't be afraid

Writing a very short page in which you get some facts right and some facts wrong is better than not writing a page at all. Others can always improve on what you did.

Speaking of which: if you see a way in which a page could be improved, please don't be shy and let us know or do it yourself!

Sources that you can use

  • The forum thread holds a lot of information, but you need to collect and organise it all by yourself.
  • Your own experience with the project.
  • Knowledge of common practice on GitHub, if you have it.