editing guide
authorMartin Taibr <taibr.martin@gmail.com>
Fri, 3 Mar 2017 16:12:52 +0000 (16:12 +0000)
committerMartin Taibr <taibr.martin@gmail.com>
Fri, 3 Mar 2017 16:12:52 +0000 (16:12 +0000)
Editing.md

index d0fee9b..64eacd6 100644 (file)
@@ -1,22 +1,18 @@
 If you want write access, please ask for it at [#xonotic on FreeNode](https://webchat.freenode.net/), we'll gladly give it to you. There is no way to allow anonymous editing on GitLab.
 
-The official version is on [GitLab](https://gitlab.com/xonotic/xonotic/wikis/home) but we also sync it to [GitHub](https://github.com/xonotic/xonotic/wiki). Please, follow this guide when editing to make sure the wiki works properly on both.
+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.
 
 Filenames
 ---------
 
-Use dashes in page names, not underscores - dashes get converted to spaces in page titles so we have a nice title on every page
+Use dashes in page names, not underscores - dashes get converted to spaces in page titles so we have a nice title on every page. Some pages might have underscores in names for historical reasons - they already have many outside links (from forums, etc.) pointing to them.
 
-Interestingly, spaces in filenames and links seem to work fine for both GitHub and GitLab, not sure if they break somewhere else.
+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.
 
 Subdirectories
 --------------
 
-Ok to use for images and other assets
-
-Don't use for pages (the `.md` files) - GitHub doesn't support them 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)
-
- - Put all `.md` files in root
+It's ok (and preferred) to put images and other assets into subdirectories but we have to **put pages (the `.md` files) 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).
 
 Links to pages
 -------------
@@ -25,4 +21,4 @@ Use standard markdown links: `[Text](link)` (e.g. `[Back to main page](Home)` to
 
  - Don't prefix `link` with either `../link` or `/link` - both break on GitHub. Using `./link` seems to work ok but is unnecessary since we have to put everything in root anyway.
 
-Links don't seem to be case sensitive but it's probably best to use proper capitalization just in case it breaks in some edge case somewhere.
+Links don't seem to be case sensitive but it's probably best to use proper capitalization just in case it breaks in some edge case somewhere. Also, spaces and dashes seem to be freely interchangeable on GH and GL but again, probably best to use dashes.