]> de.git.xonotic.org Git - xonotic/xonotic.wiki.git/blobdiff - Editing.md
Update Programming Tips
[xonotic/xonotic.wiki.git] / Editing.md
index a799f1086835b84d75b9461ad977d212716cd50b..43cb7f10948832a1fa230f3cc3797e96c8957c72 100644 (file)
@@ -1,10 +1,11 @@
-If you want write access, please ask for it at [#xonotic on FreeNode](https://webchat.freenode.net/), we'll gladly give it to you (unfortunately, there is no way to allow anonymous editing on GitLab). After that, you can edit the wiki online (there is an Edit button when logged in) or clone it to your machine using git (`git clone git@gitlab.com:xonotic/xonotic.wiki.git`).
+If you want write access, please ask for it at [#xonotic on FreeNode](https://webchat.freenode.net/) so we know you're not a bot, we'll gladly give it to you (unfortunately, there is no way to allow anonymous editing on GitLab). After that, you can edit the wiki online (there is an Edit button when logged in) or clone it to your machine using git (`git clone git@gitlab.com:xonotic/xonotic.wiki.git`).
 
 The official version is on [GitLab](https://gitlab.com/xonotic/xonotic/wikis/home) but we also sync the wiki to [GitHub](https://github.com/xonotic/xonotic/wiki). Please, follow this guide when editing to make sure everything works properly on both.
 
 - Try to keep things short and to the point
 - Avoid creating lists of stuff that people will need to keep up to date, it doesn't work
-- Don't duplicate information, there should be a single up-to-date source of truth, everytihng else should link to it
+- Don't duplicate information, there should be a single up-to-date source of truth, everything else should link to it
+    - Improve things instead of starting from scratch, if the previous author didn't finish, you're not likely to do better if you start from nothing
     - Low hanging fruit: obliterate docs from `Docs/` subdirectory, move it to wiki, link to it instead
 
 
@@ -27,7 +28,7 @@ Use dashes in page names, not underscores - dashes get converted to spaces in pa
 
 Interestingly, spaces in filenames and links seem to work fine for both GitHub and GitLab, not sure if they break somewhere else, it might still be best to avoid them.
 
-It's ok (and preferred) to put images and other assets into subdirectories but we have to **put pages in root** becuase GitHub doesn't support subdirs properly (it flattens everything - this can cause collisions, plus there is no way to link from subdir to another subdir that works on both GitLab and GitHub).
+It's ok (and preferred) to put images and other assets into subdirectories but we have to **put pages in root** because GitHub doesn't support subdirs properly (it flattens everything - this can cause collisions, plus there is no way to link from subdir to another subdir that works on both GitLab and GitHub).
 
 
 Automated checking