Merge pull request #22 from gked/gettingStarted

Home page and Get started on a new documentation platform: VuePress

.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+    "grammarly.selectors": [
+        {
+            "language": "markdown",
+            "scheme": "file"
+        }
+    ]
+}

documentation-approach-en.md

@@ -1,9 +1,5 @@
 The plan for Developer's Guide
-AI Prompts:
-I am trying to design a documentation strategy for Bastyon. I am a volunteer there who wants to help the project to move forward.
-The project is called Bastyon. It's a decentralized social platform with a messenger. It also wants to build an API set around building miniapps on Bastyon. Its source code is located at https://github.com/pocketnetteam
-The documentation is needed for app usage and developer documentation.
-What I need help with a vision for documentation, roadmap and concrete documentation design that adheres with the theory of information and other theoretical work around documentation design.
+
 
 ### Motivation
 

vuepress-starter/.github/workflows/deploy-docs.yml

@@ -0,0 +1,47 @@
+
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      # make sure this is the branch you are using
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  deploy-gh-pages:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          # if your docs needs submodules, uncomment the following line
+          # submodules: true
+
+
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20
+          cache: npm
+
+      - name: Install Deps
+        run: npm ci
+
+      - name: Build Docs
+        env:
+          NODE_OPTIONS: --max_old_space_size=8192
+        run: |-
+          npm run docs:build
+          > docs/.vuepress/dist/.nojekyll
+
+      - name: Deploy Docs
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          # This is the branch where the docs are deployed to
+          branch: gh-pages
+          folder: docs/.vuepress/dist

vuepress-starter/docs/.vuepress/.cache/deps/_metadata.json

@@ -0,0 +1,40 @@
+{
+  "hash": "811059f0",
+  "configHash": "ef91ecb6",
+  "lockfileHash": "647c4151",
+  "browserHash": "a27d6945",
+  "optimized": {
+    "@vue/devtools-api": {
+      "src": "../../../../node_modules/@vue/devtools-api/lib/esm/index.js",
+      "file": "@vue_devtools-api.js",
+      "fileHash": "0cd402fc",
+      "needsInterop": false
+    },
+    "@vuepress/shared": {
+      "src": "../../../../node_modules/@vuepress/shared/dist/index.js",
+      "file": "@vuepress_shared.js",
+      "fileHash": "33b29d11",
+      "needsInterop": false
+    },
+    "vue": {
+      "src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
+      "file": "vue.js",
+      "fileHash": "15f5234e",
+      "needsInterop": false
+    },
+    "vue-router": {
+      "src": "../../../../node_modules/vue-router/dist/vue-router.esm-bundler.js",
+      "file": "vue-router.js",
+      "fileHash": "fef20e50",
+      "needsInterop": false
+    }
+  },
+  "chunks": {
+    "chunk-UKCZNIRO": {
+      "file": "chunk-UKCZNIRO.js"
+    },
+    "chunk-ONFHZ5OS": {
+      "file": "chunk-ONFHZ5OS.js"
+    }
+  }
+}