Docs/obsidian (#158)

* obsidian: start * e * ci: workflow_dispatch * ci: temp * ci: mkdocs.yml * ci: test * ci:test * ci:test * obsidian: first commands * mprove * ci: test * test * ci:test * ci:test * ci:test * ci:test * ci:test * ci:test * ci:test * ci:test * ci:test --------- Co-authored-by: Damian Laczak <[email protected]>
shoter · Dec 29, 2023 · dea7e25 · dea7e25
1 parent e214e30
commit dea7e25
Show file tree

Hide file tree

Showing 9 changed files with 50 additions and 42 deletions.
diff --git a/Readme.md b/Readme.md
@@ -1,11 +1,16 @@
-# Openttd Discord
+
+# Openttd Discord
 
 ![GitHub](https://img.shields.io/github/license/shoter/OpenttdDiscord?style=plastic)
 ![Test badge](https://github.com/shoter/OpenttdDiscord/actions/workflows/test.yml/badge.svg)
 [![codecov](https://codecov.io/gh/shoter/OpenttdDiscord/branch/master/graph/badge.svg?token=1EC4AKIMD3)](https://codecov.io/gh/shoter/OpenttdDiscord)
 
 Provides ability to integrate Discord with your OpenTTD servers.
 
+## Documentation
+
+https://shoter.github.io/OpenttdDiscord/
+
 ## Functionalities
 
 * Connects Discord channel to the Openttd Servers enabling communication between multiple servers and Discord.
@@ -62,11 +67,11 @@ Used types:
 
 ### Actors hierarchy
 
-![Actors hierarchy](./docs/diagrams/akka.drawio.png)
+![Actors hierarchy](https://raw.githubusercontent.com/shoter/OpenttdDiscord/master/obsidian/docs/diagrams/akka.drawio.png)
 
 ### Database diagram
 
-![Database diagram](./docs/diagrams/database.drawio.png)
+![Database diagram](https://raw.githubusercontent.com/shoter/OpenttdDiscord/master/obsidian/docs/diagrams/database.drawio.png)
 
 ## Test coverage
 

diff --git a/obsidian/docs/.obsidian/app.json b/obsidian/docs/.obsidian/app.json
@@ -1 +1,3 @@
-{}
+{
+  "showInlineTitle": false
+}
diff --git a/obsidian/docs/.obsidian/workspace.json b/obsidian/docs/.obsidian/workspace.json
@@ -13,7 +13,7 @@
             "state": {
               "type": "markdown",
               "state": {
-                "file": "Commands/Server/Remove server.md",
+                "file": "index.md",
                 "mode": "source",
                 "source": false
               }
@@ -31,21 +31,6 @@
               }
             }
           }
-        ],
-        "currentTab": 1
-      },
-      {
-        "id": "4ff65423545a639b",
-        "type": "tabs",
-        "children": [
-          {
-            "id": "04f68ae85ec88369",
-            "type": "leaf",
-            "state": {
-              "type": "graph",
-              "state": {}
-            }
-          }
         ]
       }
     ],
@@ -75,7 +60,7 @@
             "state": {
               "type": "search",
               "state": {
-                "query": "",
+                "query": " ",
                 "matchingCase": false,
                 "explainSearch": false,
                 "collapseAll": false,
@@ -112,7 +97,7 @@
             "state": {
               "type": "backlink",
               "state": {
-                "file": "Commands/Server Statuses/Remove Status Monitor.md",
+                "file": "index.md",
                 "collapseAll": false,
                 "extraContext": false,
                 "sortOrder": "alphabetical",
@@ -129,7 +114,7 @@
             "state": {
               "type": "outgoing-link",
               "state": {
-                "file": "Commands/Server Statuses/Remove Status Monitor.md",
+                "file": "index.md",
                 "linksCollapsed": false,
                 "unlinkedCollapsed": true
               }
@@ -152,7 +137,7 @@
             "state": {
               "type": "outline",
               "state": {
-                "file": "Commands/Server Statuses/Remove Status Monitor.md"
+                "file": "index.md"
               }
             }
           }
@@ -173,22 +158,25 @@
       "command-palette:Open command palette": false
     }
   },
-  "active": "1bd29a07891fc1b9",
+  "active": "1337c496f21e2799",
   "lastOpenFiles": [
-    "Commands/Server Statuses/Register Status Monitor.md",
-    "Commands/Server Statuses/Remove Status Monitor.md",
+    "readme.md.md",
     "Commands/Server/Remove server.md",
-    "Commands/Server Statuses",
-    "Commands/Server/List servers.md",
+    "Commands/Server Statuses/Untitled.md",
+    "Commands/Server Statuses/Remove Status Monitor.md",
+    "index.md",
     "Commands/Server/Register Server.md",
+    "Commands/Server/List servers.md",
+    "Start.md",
+    "Commands/Server Statuses/Register Status Monitor.md",
+    "Commands/Server Statuses",
     "diagrams/readme.md",
     "Commands/Server",
     "asdsad/asd.md",
     "asdsad/xcxzc.md",
     "Commands",
     "Tes.md",
     "asdsad",
-    "readme.md.md",
     "docs",
     "New folder",
     "mathjax.js",

diff --git a/obsidian/docs/Commands/Server Statuses/Remove Status Monitor.md b/obsidian/docs/Commands/Server Statuses/Remove Status Monitor.md
@@ -1,4 +1,4 @@
-#command #serverStatus
+# Remove Status Monitor 
 
 ## Syntax
 

diff --git a/obsidian/docs/Commands/Server Statuses/Untitled.md b/obsidian/docs/Commands/Server Statuses/Untitled.md
@@ -0,0 +1,14 @@
+# Register Status Monitor 
+
+## Syntax
+
+`/register-status-monitor server-name:{name}`
+
+## Requirements
+
+- [[Register Server]]
+
+## Description
+
+Register server status monitor on current channel where slash command was executed.
+Does nothing if channel already has status monitor.
diff --git a/obsidian/docs/Commands/Server/List servers.md b/obsidian/docs/Commands/Server/List servers.md
@@ -1,4 +1,4 @@
-#command #server 
+# List Severs
 
 ## Syntax
 

diff --git a/obsidian/docs/Commands/Server/Register Server.md b/obsidian/docs/Commands/Server/Register Server.md
@@ -1,4 +1,4 @@
-#command #server
+# Register Server
 
 ## Syntax
 

diff --git a/obsidian/docs/index.md b/obsidian/docs/index.md
@@ -0,0 +1,2 @@
+
+--8<-- "Readme.md"
diff --git a/obsidian/mkdocs.yml b/obsidian/mkdocs.yml
@@ -1,7 +1,9 @@
 site_name: Openttd Discord Bot Documentation
+repo_url: https://github.com/shoter/OpenttdDiscord
+repo_name: OpenttdDiscord
 
 theme:
-    name: 'material'
+    name: 'mkdocs'
     palette:
 
     # Light mode
@@ -39,6 +41,9 @@ markdown_extensions:
   - pymdownx.keys
   - pymdownx.mark
   - pymdownx.tilde
+  - pymdownx.snippets:
+      check_paths: true
+      base_path: ..
   - pymdownx.superfences:
       custom_fences:
         - name: mermaid
@@ -51,14 +56,6 @@ markdown_extensions:
 plugins:
   - search
   - roamlinks
-  - blog
-  - rss:
-      match_path: blog/posts/.* 
-      date_from_meta:
-        as_creation: date
-      categories:
-        - categories
-        - tags
 
 extra_javascript:
   - mathjax.js