explain autobuilds

[xonotic/xonotic.wiki.git] / Editing.md

diff --git a/Editing.md b/Editing.md
index 631010354609819591beb0d7de147c56a4736474..8bb977f2885e79d10d4c5eef4fa858275fa51b74 100644 (file)
--- a/Editing.md
+++ b/Editing.md
@@ -1,10 +1,12 @@
-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.
+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.
 
 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
 ---------
 
+For pages, capitalize at least the first letter of the filename (GitHub doesn't capitalize titles automatically).
+
 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, it might still be best to avoid them.
@@ -26,4 +28,4 @@ Links don't seem to be case sensitive but it's probably best to use proper capit
 Automated checking
 -------------------
 
-Neither GL not GH support red links (highlighting broken links) so there's a script in `assets/check-and-fix.py` that does it. You can run it in the wiki root to find broken links and unreachable files. It'll also move or rename files that don't follow the above guidelines, use `--dry-run` to prevent that (or you can just revert the changes with git).
+Neither GL not GH support red links (highlighting broken links) so there's a script in [`assets/check-and-fix.py`](assets/check-and-fix.py) that finds broken links and unreachable files. To use it, clone the wiki and run the script in its root. It can also automatically move or rename files that don't follow the above guidelines if you run it with `--fix`.