feat: Docs 🎉 (#174)

Author: Paillat-dev

.github/workflows/CI-CD.yaml

@@ -3,11 +3,9 @@ name: CI/CD
 
 on:
   push:
-    branches: [ "main", "dev" ]
-    # Publish semver tags as releases.
-    tags: [ 'v*.*.*' ]
+    branches: [ "main", "master", "dev" ]
   pull_request:
-    branches: ["dev"]
+    branches: ["main", "master", "dev"]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -25,8 +23,17 @@ jobs:
       id-token: write
     uses: ./.github/workflows/docker.yaml
 
+  docs:
+    if: github.repository == 'nicebots-xyz/botkit'
+    needs: quality
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    uses: ./.github/workflows/docs.yaml
+
   deploy:
-    if: github.event_name == 'push' && github.ref == 'refs/heads/dev'
+    if: github.event_name == 'push' && github.ref_name == github.event.repository.default_branch
     needs: docker
     uses: ./.github/workflows/deploy.yaml
     secrets: inherit

.github/workflows/docs.yaml

@@ -0,0 +1,52 @@
+name: Docs
+
+on:
+  workflow_call:
+
+concurrency:
+  group: docs-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Setup PDM
+        uses: pdm-project/setup-pdm@v4
+        with:
+          cache: true
+          python-version-file: pyproject.toml
+
+      - name: Install dependencies
+        run: pdm install -d -G docs
+
+      - name: Build docs
+        run: pdm run docs:build
+
+      - name: Upload site artifact
+        if: github.event_name == 'push' && github.ref_name == github.event.repository.default_branch
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: site
+
+  deploy:
+    name: Publish docs
+    if: github.event_name == 'push' && github.ref_name == github.event.repository.default_branch
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - uses: actions/configure-pages@v6
+
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v5
+        id: deployment

.github/workflows/quality.yaml

@@ -45,8 +45,8 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v6
       - name: Setup Licensor
-        uses: nicebots-xyz/licensor/.github/actions/setup-licensor@v0.0.5
+        uses: nicebots-xyz/licensor/.github/actions/setup-licensor@v0.1.0
         with:
-          version: v0.0.5
+          version: v0.1.0
       - name: Check Header Compliance
         run: licensor check * --ignore ".*"

docs/api.md

@@ -0,0 +1,33 @@
+<!--
+SPDX-License-Identifier: MIT
+Copyright: 2024-2026 NiceBots.xyz
+-->
+# API reference
+
+Reference for extension loading and startup entry points.
+
+## Extension loader
+
+::: src.startup.loader
+    options:
+      members:
+        - load_extensions
+        - find_translation_file
+      show_submodules: false
+
+## Extension utilities
+
+::: src.utils.extensions
+    options:
+      members:
+        - validate_module
+        - unzip_extensions
+      show_submodules: false
+
+## Startup orchestration
+
+::: src.start
+    options:
+      members:
+        - start
+      show_submodules: false