summaryrefslogtreecommitdiff
path: root/docs/index.md
diff options
context:
space:
mode:
authorTor Andersson <tor@ccxvii.net>2025-04-24 12:48:51 +0200
committerTor Andersson <tor@ccxvii.net>2025-04-25 16:06:05 +0200
commited2361980b455d1825d811670f329cbcf5624927 (patch)
treea1e620490bf305635c3a0f22a6f695e22c14ff2f /docs/index.md
parent71a98cbbe0657880cfb1d81962786188b009fc5c (diff)
downloadserver-ed2361980b455d1825d811670f329cbcf5624927.tar.gz
Move docs to Markdown and use markdown renderer in server.
Diffstat (limited to 'docs/index.md')
-rw-r--r--docs/index.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..96c9a7b
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,36 @@
+# Documentation
+
+This is the documentation for the _Rally the Troops_ software and website.
+Here you will find information both about how to configure and run your own
+server instance and how to create new modules.
+
+## For players
+
+* [Tips & Tricks](/docs/tips)
+* [Tournaments](/docs/tournaments)
+
+## For developers
+
+* [Installing the server](/docs/server/install)
+* [Running a public server](/docs/server/production)
+
+## System overview
+
+* [Server architecture](/docs/overview/architecture)
+* [Database schema](/docs/overview/database)
+* [Module architecture](/docs/overview/module)
+
+## Module implementation
+
+* [Step by step guide](/docs/module/guide)
+* [Rules framework](/docs/module/rules)
+ * [Script syntax](/docs/module/script)
+ * [Utility library](/docs/module/library)
+* Create the user interface (todo)
+* Prepare the art assets (todo)
+* [Test with the Fuzzer](/docs/module/fuzzer)
+
+<!--
+* [Preparing the art assets](/docs/module/assets)
+* [How to write the client](/docs/module/play)
+-->