deploy(docs): Fix documentation build.

AmplitudeAudio · Oct 25, 2023 · 777243f · 777243f
1 parent 2609be1
commit 777243f
Show file tree

Hide file tree

Showing 3 changed files with 563 additions and 442 deletions.
diff --git a/.github/workflows/hugo.yml b/.github/workflows/hugo.yml
@@ -33,7 +33,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     env:
-      HUGO_VERSION: 0.117.0
+      HUGO_VERSION: 0.119.0
     steps:
       - name: Install Hugo CLI
         run: |
@@ -52,9 +52,28 @@ jobs:
         id: pages
         uses: actions/configure-pages@v3
 
-      - name: Install Node.js dependencies
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+          run_install: false
+
+      - name: Get pnpm store directory
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
+
+      - name: Setup pnpm cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ env.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
         working-directory: docs
-        run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
+        run: pnpm install
 
       - name: Build with Hugo
         working-directory: docs
@@ -76,10 +95,12 @@ jobs:
   deploy:
     environment:
       name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
     runs-on: ubuntu-latest
     needs: build
     steps:
       - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v2
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/public
+
diff --git a/docs/content/docs/project-setup/99-api.md b/docs/content/docs/project-setup/99-api.md
@@ -0,0 +1,45 @@
+---
+title: API
+description: ""
+menu:
+  docs:
+    parent: project-setup
+weight: 299
+toc: true
+---
+
+## RtpcCompatibleValue {#rtpc-compatible-value}
+
+An RTPC-compatible value is an object that can hold a static value or a link to an RTPC value.
+
+### kind {#rtpc-compatible-value-kind}
+
+`ValueKind` `default: Static`
+
+Specifies the kind of value that should be used. The possible values are:
+
+| ID     | Description                                                   |
+| ------ | ------------------------------------------------------------- |
+| Static | The parameter is static value specified by the `value` field. |
+| RTPC   | The parameter is a RTPC value specified by the `rtpc` field.  |
+
+When the `kind` property is set to `Static`, it is required to defined a `value` field. When the `kind` property is set to `RTPC`, it is required to define a `rtpc` field.
+
+The default value is `Static`.
+
+### value {#rtpc-compatible-value-value}
+
+`float`
+
+A static value that will be used at runtime. This property is only available when the `kind` property is set to `Static`.
+
+### rtpc {#rtpc-compatible-value-rtpc}
+
+`RtpcParameter`
+
+An object that describe how the value should be updated according to a RTPC object. This object takes as input:
+
+- `id`: The ID of the RTPC object to use.
+- `curve`: A [CurveDefinition] object that defines the function to apply on the RTPC value to compute this parameter value.
+
+[CurveDefinition]: #curve-definition