first commit

Author: josecelano

README.md

@@ -0,0 +1,3 @@
+# Torrust Index GUI User Guide
+
+[Documentation](./docs/index.md) for [Torrust Index GUI](https://github.com/torrust/torrust-index-gui).

cspell.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "version": "0.2",
+  "dictionaryDefinitions": [
+    {
+      "name": "project-words",
+      "path": "./project-words.txt",
+      "addWords": true
+    }
+  ],
+  "dictionaries": ["project-words"],
+  "ignorePaths": ["target", "/project-words.txt"]
+}

docs/backoffice.md

@@ -0,0 +1,15 @@
+# Backoffice
+
+Some settings can be customized by the `admin` role.
+
+## Categories
+
+Torrents can have only one category. You have to assign a category to your torrent when you upload it.
+
+If the "admin" deletes the category used by a torrent, the torrent category will be set to `null`.
+
+## Tags
+
+Torrents can have multiple tags. You can assign tags to your torrent when you upload it. Tags are created by the "admin" and users can only choose from the existing tags.
+
+If the "admin" deletes a tag, the tag will be removed from all the torrents that use it.

docs/index.md

@@ -0,0 +1,16 @@
+# User guide
+
+User guide for the Torrust INdex Graphical User Interface.
+
+You can see a live demo on: <https://index.torrust-demo.com>.
+
+- [Roles](./roles.md)
+- [Screenshots](./screenshots.md)
+- [Upload torrents](./upload/upload_torrents.md)
+- [Backoffice](./backoffice.md)
+
+## Notes
+
+The application does not support [BitTorrent Version 2][BEP_52].
+
+[BEP_52]: https://www.bittorrent.org/beps/bep_0052.html