Skip to content

Commit 28da3bd

Browse files
committed
docs: [#379] review User Guide
1 parent 585fbe7 commit 28da3bd

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

docs/user_guide.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
There are only three roles:
66

7-
- Guest: unauthenticated user.
8-
- User: authenticated user.
9-
- Admin: authenticated user with admin privileges.
7+
- `Guest`: unauthenticated user.
8+
- `User`: authenticated user.
9+
- `Admin`: authenticated user with admin privileges.
1010

1111
> **NOTICE**: there is only one "admin" and it's the account of the first registered user.
1212
@@ -22,17 +22,22 @@ You can add a PNG image with:
2222
![alternative description for the image](https://raw.githubusercontent.com/torrust/torrust-index-gui/develop/docs/media/torrust_logo.png)
2323
```
2424

25-
The image will be proxied by the backend. This means that the image will be downloaded by the backend and served by the backend itself. The backend will cache the image but
26-
you have to make sure that the image is available at the URL you provided.
25+
The image will be proxied by the backend. This means that the image will be downloaded by the backend and served by the backend itself. The backend will cache the image but you have to make sure that the image is available at the URL you provided.
2726

2827
## Categories
2928

3029
Torrents can have only one category. You have to assign a category to your torrent when you upload it.
3130

32-
If the "admin" deletes the category sued by a torrent, the torrent category will be set to `null`.
31+
If the "admin" deletes the category used by a torrent, the torrent category will be set to `null`.
3332

3433
## Tags
3534

3635
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.
3736

3837
If the "admin" deletes a tag, the tag will be removed from all the torrents that use it.
38+
39+
## Notes
40+
41+
- The application does not support [BitTorrent Version 2][BEP_52].
42+
43+
[BEP_52]: https://www.bittorrent.org/beps/bep_0052.html

0 commit comments

Comments
 (0)