zvecr 4 years ago
parent
commit
90fc901624
2 changed files with 10 additions and 1 deletions
  1. 3 0
      docs/index.html
  2. 7 1
      docs/xap.md

+ 3 - 0
docs/index.html

@@ -128,6 +128,8 @@
   <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
   <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
   <script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
+  <script src="//unpkg.com/mermaid/dist/mermaid.js"></script>
+  <script src="//unpkg.com/docsify-mermaid@latest/dist/docsify-mermaid.js"></script>
   <script src="//unpkg.com/docsify-tabs@1"></script>
   <script src="//unpkg.com/docsify-copy-code@2"></script>
   <script src="//unpkg.com/docsify-toc@1.1.0/dist/toc.js"></script>
@@ -143,5 +145,6 @@
       navigator.serviceWorker.register('sw.js')
     }
   </script>
+  <script>mermaid.initialize({ startOnLoad: true });</script>
 </body>
 </html>

+ 7 - 1
docs/xap.md

@@ -4,7 +4,13 @@ XAP (“extensible application protocol”) API intends to provide access to var
 
 ## Overview
 
-TODO
+```mermaid
+%%{init: {'themeVariables': { 'fontSize': '24px'}}}%%
+flowchart LR
+    dev[QMK Device] <-- XAP --> host[Host Computer]
+```
+
+The intention is to provide access to QMK subsystems through a versioned and documented protocol. 
 
 ## Protocol Reference