Upd: Further documentation improvements

docs/030-running.md

@@ -7,7 +7,7 @@ title: Running
 On startup myMPD does the following:
 
 - Check and create `cachedir` and `workdir` directories.
-    - `cachedir` and `workdir` must exist, if not started as root.
+    - `cachedir` and `workdir` must exist and be writeable for the user, if not started as root.
 - Reads environment at first startup.
 - Binds to the configured http and ssl port.
 - Dropping privileges, if started as root.

docs/040-debug.md

@@ -16,11 +16,14 @@ Tips to debug problems with myMPD. Try these steps and reproduce the error.
 - Reset loglevel: `unset MYMPD_LOGLEVEL`
 
 !!! note
-    Use [systemd-run](030-running.md#manual-startup), if you use a distribution with systemd
+    Use [systemd-run](030-running.md#manual-startup), if you use a distribution with systemd.
 
 ### Get logs from running myMPD
 
-You can set the log level in the Maintenance dialog to `debug` and get the output from your logging service, for systemd it is: `journalctl -fu mympd`.
+You can set the log level in the Maintenance dialog to `debug` and get the output from your logging service.
+
+- Systemd: `journalctl -fu mympd`
+- Syslog: `tail -f /var/log/messages` (or the logfile for facility `daemon`)
 
 ## Webbrowser logging
 

docs/060-references/api/.pages

@@ -0,0 +1 @@
+title: API Documentation

docs/060-references/api/index.md

@@ -6,10 +6,10 @@ myMPD uses a JSON-RPC 2 for the communication between frontend and backend.
 
 ## JSON-RPC Id
 
-The json rpc is the combination of two numeric ids.
+The json-rpc Id is the combination of two numeric ids.
 
-1. Client ID: Generated on initial loading of the client, 6 digits
-2. Request ID: Incremented on each request, 3 digits, wraps around
+1. Client ID: Generated on initial loading of the client, first 6 digits
+2. Request ID: Incremented on each request, last 3 digits, wraps around
 
 The websocket connection registers the Client ID on the webserver. This registration is used to send async responses from the webserver to a specific client.
 

docs/060-references/api/methods.md

@@ -2,21 +2,14 @@
 title: API Methods
 ---
 
-<form>
-  <div class="form-group row">
-    <label for="selectMethod" class="col-sm-2 col-form-label">Goto method</label>
-    <div class="col-sm-10">
-      <select class="custom-select" id="selectMethod"></select>
-    </div>
-  </div>
-</form>
+<select class="custom-select" id="selectMethod"></select>
 
-<table class="table">
+<table>
   <thead>
     <tr><th>Method</th><th>Parameters</th></tr>
   </thead>
   <tbody>
   </tbody>
 </table>
-<script src="assets/apidoc.js"></script>
-<script src="assets/create-apidoc.js"></script>
+<script src="../../../assets/apidoc.js"></script>
+<script src="../../../assets/create-apidoc.js"></script>

docs/060-references/partitions.md

@@ -17,7 +17,6 @@ Following items are partition specific:
 
 You can select and manage partitions in the web interface. The selected partition for the web interface is saved in the browsers localStorage.
 
-## Notes
-
-- The `default` partition can not be deleted.
-- Do not use a partition with the name `!all!`. It is used internally by myMPD.
+!!! note
+    - The `default` partition can not be deleted.
+    - Do not use a partition with the name `!all!`. It is used internally by myMPD.

docs/assets/create-apidoc.js

@@ -17,15 +17,15 @@ function init() {
         tbody.appendChild(tr);
     }
 
-    let options = '<option></option>';
+    let options = '<option value="">Show method</option>';
     for (const method of methods) {
         options += '<option value="' + method + '">' + method + '</option>';
     }
 
     let select = document.getElementById('selectMethod');
     select.innerHTML = options;
-    select.addEventListener('change', function() {
-        const m = this.options[this.selectedIndex].value;
+    select.addEventListener('change', function(event) {
+        const m = event.target.options[this.selectedIndex].value;
         if (m !== '') {
             for (const row of tbody.rows) {
                 if (row.getAttribute('id') === m) {
@@ -36,6 +36,11 @@ function init() {
                 }
             }
         }
+        else {
+            for (const row of tbody.rows) {
+                row.classList.remove('d-none');
+            }
+        }
     }, false);
 }
 

docs/assets/css/mympd.css

@@ -5,3 +5,7 @@
     --md-accent-fg-color: #28a745;
     --md-accent-fg-color--transparent: #28a745;
 }
+
+.d-none {
+    display: none;
+}