Merge pull request #28 from gked/devDocs

Dev docs
pocketnetteam · Nov 7, 2024 · db8a8ba · db8a8ba
2 parents 85ca2fa + d22bfc3
commit db8a8ba
Show file tree

Hide file tree

Showing 19 changed files with 1,551 additions and 75 deletions.
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
@@ -0,0 +1,43 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  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
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: '.'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts
@@ -8,6 +8,7 @@ import { shikiPlugin } from '@vuepress/plugin-shiki'
 import { defaultTheme } from '@vuepress/theme-default'
 import { defineUserConfig } from 'vuepress'
 import { getDirname, path } from 'vuepress/utils'
+import { mdEnhancePlugin } from 'vuepress-plugin-md-enhance'
 import {
   head,
   navbarEn,
@@ -134,6 +135,10 @@ export default defineUserConfig({
 
   // use plugins
   plugins: [
+    mdEnhancePlugin({
+      // Enable mermaid
+      mermaid: true
+    }),
     docsearchPlugin({
       appId: '', // TODO appId
       apiKey: '', // TODO apiKey

diff --git a/docs/.vuepress/configs/navbar/en.ts b/docs/.vuepress/configs/navbar/en.ts
@@ -3,37 +3,58 @@ import { VERSION } from '../meta.js'
 
 export const navbarEn: NavbarOptions = [
   {
-    text: 'Guide',
+    text: 'User Center',
     children: [
-      '/dev/introduction.md',
-      '/dev/get-started.md',
-      '/dev/infrastructure.md',
-      '/dev/contribution.md',
+      {
+        text: 'Get Started',
+        children: [
+          '/guide/getting-started.md',
+          '/guide/easy-node/index.md',
+        ],
+      },
+      {
+        text: 'Monetization',
+        children: [
+          '/guide/monetization/index.md',
+        ],
+      },
     ],
   },
   {
-    text: 'Blockchain',
+    text: 'Developer Docs',
     children: [
-      '/dev/node/get-started.md',
-      '/dev/node/requirements.md',
-      '/dev/node/environment.md',
-      '/dev/node/building.md',
-      '/dev/node/contribution.md',
+      {
+        text: 'Platform Overview',
+        children: [
+          'dev/introduction.md',
+          'dev/CONTRIBUTING.md',
+        ],
+      },
+      {
+        text: 'Blockchain',
+        children: [
+          '/dev/node/get-started.md',
+          '/dev/node/requirements.md',
+          '/dev/node/environment.md',
+          '/dev/node/building.md',
+        ],
+      },
+      {
+        text: 'Proxy & API',
+        children: [
+          '/dev/api/introduction.md',
+          '/dev/api/get-started.md',
+        ],
+      },
+      {
+        text: 'Applications',
+        children: [
+          '/dev/apps/introduction.md',
+          '/dev/apps/get-started.md',
+          '/dev/apps/mini-apps.md',
+          '/dev/apps/barteron-app.md',
+        ],
+      },
     ],
   },
-  {
-    text: 'Proxy & API',
-    children: [
-      '/dev/api/introduction.md',
-      '/dev/api/get-started.md',
-    ],
-  },
-  {
-    text: 'Applications',
-    children: [
-      '/dev/apps/introduction.md',
-      '/dev/apps/get-started.md',
-    ],
-  },
-
 ] as NavbarOptions
diff --git a/docs/.vuepress/configs/sidebar/en.ts b/docs/.vuepress/configs/sidebar/en.ts
@@ -1,44 +1,54 @@
 import type { SidebarOptions } from '@vuepress/theme-default'
 
 export const sidebarEn: SidebarOptions = {
+  '/guide/': [
+    {
+      text: 'Users',
+      children: [
+        '/guide/getting-started.md',
+        '/guide/monetization/index.md',
+        '/guide/easy-node/index.md',
+      ],
+    },
+  ],
+
   '/dev/': [
     {
-      text: 'Guide',
+      text: 'Developers',
       children: [
-        '/dev/introduction.md',
-        '/dev/get-started.md',
-        '/dev/infrastructure.md',
-        '/dev/contribution.md',
+        'introduction.md',
+        'CONTRIBUTING.md',
       ],
     },
   ],
   '/dev/node': [
     {
       text: 'Blockchain',
       children: [
-        '/dev/node/get-started.md',
-        '/dev/node/requirements.md',
-        '/dev/node/environment.md',
-        '/dev/node/building.md',
-        '/dev/node/contribution.md',
+        'get-started.md',
+        'requirements.md',
+        'environment.md',
+        'building.md',
       ],
     },
   ],
   '/dev/api': [
     {
       text: 'Proxy & API',
       children: [
-        '/dev/api/introduction.md',
-        '/dev/api/get-started.md',
+        'introduction.md',
+        'get-started.md',
       ],
     },
   ],
   '/dev/apps': [
     {
       text: 'Applications',
       children: [
-        '/dev/apps/introduction.md',
-        '/dev/apps/get-started.md',
+        'introduction.md',
+        'get-started.md',
+        'mini-apps.md',
+        'barteron-app.md',
       ],
     },
   ],