Home A - Z

An Otter Wiki

Commit fe9230

Contributing To The Wiki
@@ 0,0 1,32@@
+ # Contributing to the wiki
+
+ Hi, thanks so much for your interest in helping flesh out this wiki. It's pretty straightforward if you've ever used a CMS platform like Wordpress, but here are some high level things to keep in mind:
+
+ **niceRO Wiki is written in markdown**
+ If you've used Discord or cohost you've seen mardown before. Basically, it's just a syntax for styling text on a page. The wiki editor has helpful buttons along the top of the screen if you don't know any syntax, but I recommend familiarizing yourself with some basics to make editing quicker:
+
+ - Headers: add a hashtag before your text (the number of hashtags indicates the header level) `#YOUR HEADER 1`
+ - **Bold**: wrap text in two asterisks `**YOUR BOLD TEXT**`
+ - *Italics*: wrap text in one asterisk `*YOUR ITALIC TEXT*`
+ - [Page links](/contributing-to-the-wiki): link directly to another wiki page by wrapping text in double brackets `[[PAGE NAME]]`
+ - [External link](ragnarok.gay): wrap text in single brackets (this will be the clickable text) and the URL in parenthathese `[LINK TEXT](https://your.link)`
+ - Images: same as regular links, but make sure your link ends in an image extension (.jpg, .png, .gif, etc)
+ - `Code`: wrap text in tildes `` `YOUR CODE` ``
+
+ **niceRO wiki requires accounts for editors**
+ To prevent spam and accidental edits, you have to sign up for an account to edit the wiki. Note: there is currently no mail server for the wiki so you will not be able to reset your password if you make a mistake. Email Nathalie at [contact@kritiqal.com](mailto:contact@kritiqal.com) if you have problems with your account. Please make your name something distinct to you or your account may get deleted.
+
+ **Images require external hosting**
+ The niceRO wiki cannot host files locally so you will have to upload them somewhere else and link back. Ideally chose a host that will not delete the image (I use [ImgBB](https://imgbb.com/) but there are many options).
+
+ **Style notes**
+ You don't actually have to worry to much about styling your page as I will look at each page and make updates if needed, but a few things that would help make the wiki consistent and easy to read:
+
+ - SAVE YOUR EDITS TO A LOCAL FILE. This wiki can occasionally time out when trying to save so always copy/paste your work into a notepad before saving. If it does time out, you can usually recover by hitting the back button and trying again.
+ - Add clear commit messages. Even if you're just changing a word or punctuation it makes it a lot easier to understand the edit history.
+ - If you're referring to a file wrap it in a code block.
+ - Use appropriate header levels (eg. don't nest a level 4 header inside a level 1)
+ - Be specific and as verbose as necessary (this wiki is for people of all knowledge levels)
+ - Only create standalone pages for topics that are distinct or need lots of space. Otherwise, try to nest related items together (eg. we might not need standalone pages for every job and can put them all on one jobs page, unless someone wants to write a novel about how to play a monk in which case it makes sense to break it out as a separate page)
+
+ This page will be updated as we get more editors and the wiki expands. If you have any suggestions feel free to add them or email Nathalie at [contact@kritiqal.com](mailto:contact@kritiqal.com)