Merge pull request #65 from babeloff/main

On Writing Documentation

.github/workflows/main.yml

@@ -1,19 +1,32 @@
-name: Build and Publish Docs
+# https://squidfunk.github.io/mkdocs-material/publishing-your-site/#github-pages
+
+name: Build and Publish User Docs
 on:
   push:
     branches:
       - main
-
+      - mkdocs
+permissions:
+  contents: write
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
         with:
           python-version: 3.x
+#      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+#      - uses: actions/cache@v3
+#        # https://github.com/actions/cache
+#        with:
+#          key: mkdocs-material-${{ env.cache_id }}
+#          path: .cache
+#          restore-keys: |
+#            mkdocs-material-
       - run: >-
           pip install mkdocs-material mkdocs-awesome-pages-plugin 
           mkdocs-section-index mkdocs-toc-sidebar-plugin mike 
           markdown-include mkdocs-pdf-export-plugin
+      # https://www.mkdocs.org/user-guide/cli/#mkdocs-gh-deploy
       - run: cd docs && mkdocs gh-deploy --force

README.md

@@ -1,7 +1,7 @@
 # FreeTAKServer-User-Docs
 FreeTAKServer documentation for end users
 
-https://freetakteam.github.io/FreeTAKServer-User-Docs/
+<https://freetakteam.github.io/FreeTAKServer-User-Docs/>
 
 ## Notes for documentation updates
 

docs/docs/API/.pages

@@ -1,3 +1,4 @@
 nav:
-    - REST_API_Doc.md
-    - REST_API_InternalDoc.md
+    - REST API:
+        - External API: REST_API_Doc.md
+        - Internal API: REST_API_InternalDoc.md