Docs/bootstrap docusaurus

.github/workflows/docusaurus.yml

@@ -0,0 +1,56 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - "dev"
+      - "main"
+
+jobs:
+  build:
+    name: Build Docusaurus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install Dependencies
+        working-directory: ./docs
+        run: |
+          echo "installing pnpm"
+          npm install -g pnpm
+          echo "installing deps for packages"
+          pnpm i
+
+      - name: Build website
+        working-directory: ./docs
+        run: pnpm build
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+
+    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+## Installation
+
+```bash
+yarn
+```
+
+## Local Development
+
+```bash
+yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+## Build
+
+```bash
+yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+## Deployment
+
+Using SSH:
+
+```bash
+USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```bash
+GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/docs/Getting Started/_category_.json

@@ -0,0 +1,7 @@
+{
+    "label": "Getting Started",
+    "position": 1,
+    "link": {
+        "type": "generated-index"
+    }
+}

docs/docs/Getting Started/getting-started.md

@@ -0,0 +1,47 @@
+---
+sidebar_position: 1
+---
+
+# Tutorial Intro
+
+Let's discover **Docusaurus in less than 5 minutes**.
+
+## Getting Started
+
+Get started by **creating a new site**.
+
+Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
+
+### What you'll need
+
+- [Node.js](https://nodejs.org/en/download/) version 20.0 or above:
+  - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
+
+## Generate a new site
+
+Generate a new Docusaurus site using the **classic template**.
+
+The classic template will automatically be added to your project after you run the command:
+
+```bash
+npm init docusaurus@latest my-website classic
+```
+
+You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
+
+The command also installs all necessary dependencies you need to run Docusaurus.
+
+## Start your site
+
+Run the development server:
+
+```bash
+cd my-website
+npm run start
+```
+
+The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
+
+The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
+
+Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.

docs/docs/Post Platform Guide/_category_.json

@@ -0,0 +1,7 @@
+{
+    "label": "Post Platforms Guide",
+    "position": 4,
+    "link": {
+        "type": "generated-index"
+    }
+}

docs/getting-started.md → docs/docs/Post Platform Guide/getting-started.md

@@ -1,3 +1,7 @@
+---
+sidebar_position: 1
+---
+
 # Getting Started with Platform Development
 
 This guide will help you get started building platforms in the metastate ecosystem. We'll cover the essential concepts and patterns you'll need to implement, using `@eCurrency-api` as a reference example.
@@ -212,13 +216,4 @@ JWT_SECRET=your-secret-key-here
 
 # Registry base URL for signature verification
 PUBLIC_REGISTRY_URL=https://registry.example.com
-```
-
-### Next Steps
-
-1. **[Webhook Controller](./webhook-controller.md)** - How to handle incoming webhooks from the eVault system
-2. **[Mapping Rules](./mapping-rules.md)** - How to create mappings between global ontology and your local database schema
-
-These components work together to create a seamless integration between your platform and the W3DS ecosystem.
-
 

docs/mapping-rules.md → docs/docs/Post Platform Guide/mapping-rules.md

@@ -1,3 +1,7 @@
+---
+sidebar_position: 1
+---
+
 # Mapping Rules
 
 This document explains how to create mappings for the web3-adapter system, which enables data exchange between different platforms using a universal ontology.

docs/webhook-controller.md → docs/docs/Post Platform Guide/webhook-controller.md

@@ -1,3 +1,7 @@
+---
+sidebar_position: 3
+---
+
 # Webhook Controller Guide
 
 The webhook controller receives awareness protocol packets from the eVault system and saves them to your local database.
@@ -101,9 +105,4 @@ handleWebhook = async (req: Request, res: Response) => {
         res.status(500).send();
     }
 };
-```
-
-## Related Documentation
 
-- **[Getting Started](./getting-started.md)** - Authentication and platform setup
-- **[Mapping Rules](./mapping-rules.md)** - How to create mappings between global and local schemas

docs/docs/W3DS Basics/_category_.json

@@ -0,0 +1,7 @@
+{
+    "label": "W3DS Basics",
+    "position": 2,
+    "link": {
+        "type": "generated-index"
+    }
+}

docs/docs/W3DS Basics/getting-started.md

@@ -0,0 +1,47 @@
+---
+sidebar_position: 1
+---
+
+# Tutorial Intro
+
+Let's discover **Docusaurus in less than 5 minutes**.
+
+## Getting Started
+
+Get started by **creating a new site**.
+
+Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
+
+### What you'll need
+
+- [Node.js](https://nodejs.org/en/download/) version 20.0 or above:
+  - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
+
+## Generate a new site
+
+Generate a new Docusaurus site using the **classic template**.
+
+The classic template will automatically be added to your project after you run the command:
+
+```bash
+npm init docusaurus@latest my-website classic
+```
+
+You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
+
+The command also installs all necessary dependencies you need to run Docusaurus.
+
+## Start your site
+
+Run the development server:
+
+```bash
+cd my-website
+npm run start
+```
+
+The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
+
+The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
+
+Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.

docs/docs/W3DS Protocol/_category_.json

@@ -0,0 +1,7 @@
+{
+    "label": "W3DS Protocol",
+    "position": 3,
+    "link": {
+        "type": "generated-index"
+    }
+}

docs/docs/W3DS Protocol/getting-started.md

@@ -0,0 +1,47 @@
+---
+sidebar_position: 1
+---
+
+# Tutorial Intro
+
+Let's discover **Docusaurus in less than 5 minutes**.
+
+## Getting Started
+
+Get started by **creating a new site**.
+
+Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
+
+### What you'll need
+
+- [Node.js](https://nodejs.org/en/download/) version 20.0 or above:
+  - When installing Node.js, you are recommended to check all checkboxes related to dependencies.
+
+## Generate a new site
+
+Generate a new Docusaurus site using the **classic template**.
+
+The classic template will automatically be added to your project after you run the command:
+
+```bash
+npm init docusaurus@latest my-website classic
+```
+
+You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
+
+The command also installs all necessary dependencies you need to run Docusaurus.
+
+## Start your site
+
+Run the development server:
+
+```bash
+cd my-website
+npm run start
+```
+
+The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
+
+The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
+
+Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.