Update Nitro docs (#127)

* docs: add nitro docus

* huge update on Nitro docs

* Update github version and stars

* Add CICD for nitro docs and enable posthog plugin

* disable nitro build for docs/** path

* Change support.md

---------

Co-authored-by: 0xSage <[email protected]>
Co-authored-by: Service Account <[email protected]>

Author: 3 people

.github/workflows/build.yml

@@ -5,10 +5,10 @@ on:
     branches:
       - main
     tags: ['v*.*.*']
-    paths: ['.github/scripts/**','.github/workflows/**', '**/CMakeLists.txt', '**/Makefile', '**/*.h', '**/*.hpp', '**/*.c', '**/*.cpp', '**/*.cu']
+    paths: ['.github/scripts/**','.github/workflows/build.yml', '**/CMakeLists.txt', '**/Makefile', '**/*.h', '**/*.hpp', '**/*.c', '**/*.cpp', '**/*.cu', '!docs/**', '!.gitignore']
   pull_request:
     types: [opened, synchronize, reopened]
-    paths: ['.github/scripts/**','.github/workflows/**', '**/CMakeLists.txt', '**/Makefile', '**/*.h', '**/*.hpp', '**/*.c', '**/*.cpp', '**/*.cu']
+    paths: ['.github/scripts/**','.github/workflows/build.yml', '**/CMakeLists.txt', '**/Makefile', '**/*.h', '**/*.hpp', '**/*.c', '**/*.cpp', '**/*.cu', '!docs/**', '!.gitignore']
 
 env:
   BRANCH_NAME: ${{ github.head_ref || github.ref_name }}

.github/workflows/docs.yml

@@ -0,0 +1,73 @@
+name: Nitro Docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install jq      
+        uses: dcarbone/[email protected]
+
+      - name: Fill env vars
+        run: |
+          env_example_file=".env.example"
+          touch .env
+          while IFS= read -r line || [[ -n "$line" ]]; do
+            if [[ "$line" == *"="* ]]; then
+              var_name=$(echo $line | cut -d '=' -f 1)
+              echo $var_name
+              var_value="$(jq -r --arg key "$var_name" '.[$key]' <<< "$SECRETS")"
+              echo "$var_name=$var_value" >> .env
+            fi
+          done < "$env_example_file"
+        working-directory: docs
+        env:
+          SECRETS: '${{ toJson(secrets) }}'
+
+      - name: Install dependencies
+        run: yarn install
+        working-directory: docs
+      - name: Build website
+        run: sed -i '/process.env.DEBUG = namespaces;/c\// process.env.DEBUG = namespaces;' ./node_modules/debug/src/node.js && yarn build
+        working-directory: docs
+      
+      - name: Add Custome Domain file
+        if: github.event_name == 'push' && github.event.pull_request.head.repo.full_name != github.repository
+        run: echo "${{ vars.DOCUSAURUS_DOMAIN }}" > ./docs/build/CNAME
+
+      # Popular action to deploy to GitHub Pages:
+      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
+      - name: Deploy to GitHub Pages
+        if: github.event_name == 'push' && github.event.pull_request.head.repo.full_name != github.repository
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./docs/build
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

.gitignore

@@ -48,7 +48,7 @@
 *.pdb
 
 # Kernel Module Compile Results
-*.mod*
+*.mod
 *.cmd
 .tmp_versions/
 modules.order

docs/.env.example

@@ -0,0 +1,2 @@
+POSTHOG_PROJECT_API_KEY=xxxx
+POSTHOG_APP_URL=xxxx

docs/.gitignore

@@ -0,0 +1,21 @@
+# 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*
+.env

docs/README.md

@@ -0,0 +1,45 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ 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
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ 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.
+
+### Additional Plugins
+- @docusaurus/theme-live-codeblock
+- [Redocusaurus](https://redocusaurus.vercel.app/): manually upload swagger files at `/openapi/OpenAPISpec.json`

docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/blog/authors.yml

@@ -0,0 +1,6 @@
+dan-jan:
+  name: Daniel Onggunhao
+  title: Co-Founder
+  url: https://github.com/dan-jan 
+  image_url: https://avatars.githubusercontent.com/u/101145494?v=4
+  email: [email protected]

docs/blog/hello-world.md

@@ -0,0 +1,12 @@
+---
+title: Hello World
+description: This is my first post on Docusaurus.
+slug: hello-world 
+authors:
+  - name: Daniel
+tags: [hello, jan]
+image: https://i.imgur.com/mErPwqL.png
+hide_table_of_contents: false
+---
+
+Hello World!