chore: new docs website (#199)

* better docs

* docs only

* clean up

* fix

* wip

* adding troubleshooting, limitations

* ignore files

* fixing logger

* fix cli

* add cli options

* adding CLI options

* correct the description of --generate-path

* allow stdout/stderr for custom logger methods in config.rs

* fix

* better error message

* enhancing the ignore patterns

* ignore examples

* CLI info

* hrm

* rename docco

* cleanup

* adding type generation

* clean up

* fix

* fix broken footers

* adding pages

* fix

* change docs deploy to main push

---------

Co-authored-by: JasonShin <[email protected]>
Co-authored-by: JasonShin <[email protected]>

Author: 3 people

.github/workflows/deploy-gh-pages.yaml

@@ -1,7 +1,7 @@
 name: Deploy docs/install-script to gh-pages branch for public use
 on:
-  release:
-    types: [created]
+  push:
+    branches: [main]
 
 jobs:
   publish-docs-and-install-script:
@@ -13,13 +13,16 @@ jobs:
       - name: Checkout 🛎️
         uses: actions/checkout@v3
 
-      - name: Setup mdBook
-        uses: peaceiris/actions-mdbook@v1
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
         with:
-          mdbook-version: 'latest'
+          node-version: 22.x
 
-      - name: compiles the documentation
-        run: mdbook build
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build
+        run: npm run build
 
       - name: copies install.sh into the deployment folder
         run: cp ../scripts/install.sh ./book/

.gitignore

@@ -17,7 +17,8 @@ node_modules
 node/README.md
 
 # book
-book/book
+_book/book
+book/.docusaurus
 
 # vscode
 .run

Cargo.lock

@@ -34,6 +34,7 @@ tokio = { version = "1.40.0", features = ["rt-multi-thread", "macros", "default"
 async-recursion = "1.1.1"
 async-trait = "0.1.82"
 bb8 = "0.8.5"
+log = "0.4.22"
 
 [dev-dependencies]
 assert_cmd = "2.0.16"

Cargo.toml

@@ -1 +1,20 @@
-book
+# 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*

book/.gitignore

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](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.