Clean up docs / manual merge

.github/workflows/static.yml

@@ -16,7 +16,6 @@ permissions:
   id-token: write
 
 # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
 concurrency:
   group: "pages"
   cancel-in-progress: false
@@ -31,13 +30,20 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+
+      # Run the build script to generate the site directory
+      - name: Run build script
+        run: ./build.sh
+
       - name: Setup Pages
         uses: actions/configure-pages@v5
+
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          # Upload entire repository
+          # Upload generated ./site directory
           path: './site'
+
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4

.gitignore

@@ -1,5 +1,4 @@
 .DS_Store
 docs/.DS_Store
-.DS_Store
-docs/.DS_Store
-pkt/.DS_Store
+env
+site

README.md

@@ -1 +1,12 @@
-Mkdocs can auto generate docs website into static files. To do that you need to run - ``mkdocs build`` command on your server and Mkdocs will generate ``site`` folder with all static files. When files will be generated you need to point your server to Mkdocs folder where ``site`` folder was generated. Root file is - ``index.html``.
+# PKT Docs
+
+This is the documentation for the PKT project.
+When you push to this repository, github will build the documentation.
+
+To test the documentation before submitting your pull request, run:
+
+```bash
+./build.sh serve
+```
+
+And then naviagate your browser to http://127.0.0.1:8000/

build.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+if [ -e ./env/bin/activate ] ; then
+    . ./env/bin/activate
+else
+    rm -rf ./env
+    mkdir ./env
+    python3 -m venv ./env
+    . ./env/bin/activate
+fi
+
+pip install mkdocs
+pip install ./theme-moonstone
+mkdocs build
+
+for arg in "$@"; do
+    if [ "$arg" = "serve" ]; then
+        mkdocs serve
+    fi
+done

mkdocs.yml

@@ -7,7 +7,6 @@ repo_url: "https://github.com/pkt-cash/pkt-docs"
 plugins:
   - search
 
-
 theme:
   name: moonstone
   custom_dir: custom_theme
@@ -75,7 +74,6 @@ extra:
   meta:
     title: "PKT Documentation"
     description: "PKT is a stake-to-earn model, built on Coinbase’s Base blockchain, which rewards users that power its decentralized media network."
-    sitemap_url: /sitemap.xml
 
 extra_css:
     - css/extra.css