ci: generate reference documentation

.github/workflows/deploy-doc.yml

@@ -0,0 +1,67 @@
+name: Deploy Ref Doc
+
+on:
+  # Runs on tags
+  push:
+    tags:
+      - '**'
+
+  # 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 one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+# Default to bash
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup PNPM
+        uses: pnpm/action-setup@v2.2.2
+      - name: Setup Node
+        uses: actions/setup-node@v3.3.0
+        with:
+          node-version: 17
+          check-latest: true
+          cache: 'pnpm'
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v1
+      - name: Install dependencies
+        run: pnpm install
+      - name: Build doc
+        run: pnpm run doc
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: ./docs
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-20.04
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.github/workflows/deploy.yml → .github/workflows/deploy-package.yml

@@ -1,4 +1,4 @@
-name: Deploy
+name: Deploy to NPM
 
 on:
   workflow_dispatch:

packages/clients/README.md

@@ -3,7 +3,7 @@
 This SDK enables you to interact with Scaleway APIs.
 
 **🔗  Important links:**
-* Reference documentation (soon)
+* [Reference documentation](https://scaleway.github.io/scaleway-sdk-js)
 * [Example projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
 * [Developers website](https://developers.scaleway.com) (API documentation)
 

typedoc.json

@@ -6,5 +6,6 @@
     "out": "docs",
     "excludeInternal": true,
     "excludePrivate": true,
-    "excludeProtected": true
+    "excludeProtected": true,
+    "readme": "none"
 }