Improve documentation. (#104)

2021-12-09 17:39:26 +01:00 · 2021-12-09 17:39:26 +01:00 · 4444a44b7f
commit 4444a44b7f
parent 47245ec1d9
15 changed files with 11 additions and 0 deletions
--- a/mkdocs/README.md
+++ b/mkdocs/README.md
@ -0,0 +1 @@
+Gif generated using https://ezgif.com with delay=200
--- a/mkdocs/docs/getting-started.md
+++ b/mkdocs/docs/getting-started.md
@ -77,9 +77,19 @@ You can see the default configuration file with some explanation comments [here]

 Here there is a list of all available routes with their torrents and some info. You can add and remove torrents from here too.

+![routes screen](/images/distribyted-routes-border-large.png)
+
 ### Servers

 Servers is a way to generate magnet files from folders. 
 All servers configured using the config yaml file will be here. 
 When some data is changed on these folders, a new magnet URI will be generated. 
 You can share that magnet URI with anyone to share these files.
+
+![server screen](/images/distribyted-server-border.png)
+
+### Logs
+
+You can check logs in real time from the web interface:
+
+![logs screen](/images/distribyted-logs-border.png)
--- a/mkdocs/docs/images/distribyted-dashboard-border-large.png
+++ b/mkdocs/docs/images/distribyted-dashboard-border-large.png
--- a/mkdocs/docs/images/distribyted-dashboard-border.png
+++ b/mkdocs/docs/images/distribyted-dashboard-border.png
--- a/mkdocs/docs/images/distribyted-dashboard-no-border-large.png
+++ b/mkdocs/docs/images/distribyted-dashboard-no-border-large.png
--- a/mkdocs/docs/images/distribyted-dashboard-no-border.png
+++ b/mkdocs/docs/images/distribyted-dashboard-no-border.png
--- a/mkdocs/docs/images/distribyted-logs-border.png
+++ b/mkdocs/docs/images/distribyted-logs-border.png
--- a/mkdocs/docs/images/distribyted-logs-no-border.png
+++ b/mkdocs/docs/images/distribyted-logs-no-border.png
--- a/mkdocs/docs/images/distribyted-routes-border-large.png
+++ b/mkdocs/docs/images/distribyted-routes-border-large.png
--- a/mkdocs/docs/images/distribyted-routes-border.png
+++ b/mkdocs/docs/images/distribyted-routes-border.png
--- a/mkdocs/docs/images/distribyted-routes-no-border-large.png
+++ b/mkdocs/docs/images/distribyted-routes-no-border-large.png
--- a/mkdocs/docs/images/distribyted-routes-no-border.png
+++ b/mkdocs/docs/images/distribyted-routes-no-border.png
--- a/mkdocs/docs/images/distribyted-server-border.png
+++ b/mkdocs/docs/images/distribyted-server-border.png
--- a/mkdocs/docs/images/distribyted-server-no-border.png
+++ b/mkdocs/docs/images/distribyted-server-no-border.png
--- a/mkdocs/docs/images/distribyted.gif
+++ b/mkdocs/docs/images/distribyted.gif
				`@ -0,0 +1 @@`
				`Gif generated using https://ezgif.com with delay=200`