Merge branch 'main' into docs-replace-callout

Author: deven367

.github/workflows/build-docs.yaml

@@ -4,9 +4,8 @@ on:
     branches: [main]
   pull_request:
     branches: [main]
-
-env:
-  QUARTO_PREVIEW: "1"
+  release:
+    types: [published]
 
 jobs:
   build-docs:
@@ -32,8 +31,18 @@ jobs:
       - name: Build Docs
         run: make all_docs
 
-      - name: Deploy
-        if: github.event_name == 'push'
+      - name: Deploy (Push to main or Pull Request)
+        if: (github.event_name == 'push' && github.ref == 'refs/heads/main') || github.event_name == 'pull_request'
+        uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: docs-preview
+          publish_dir: docs/mintlify
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Deploy (Release)
+        if: github.event_name == 'release'
         uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -42,8 +51,21 @@ jobs:
           user_name: github-actions[bot]
           user_email: 41898282+github-actions[bot]@users.noreply.github.com
 
-      - name: Trigger mintlify workflow
-        if: github.event_name == 'push'
+      - name: Trigger mintlify workflow (Push to main or Pull Request)
+        if: (github.event_name == 'push' && github.ref == 'refs/heads/main') || github.event_name == 'pull_request'
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          github-token: ${{ secrets.DOCS_WORKFLOW_TOKEN }}
+          script: |
+            await github.rest.actions.createWorkflowDispatch({
+              owner: 'nixtla',
+              repo: 'docs',
+              workflow_id: 'mintlify-action-preview.yml',
+              ref: 'main',
+            });
+
+      - name: Trigger mintlify workflow (Release)
+        if: github.event_name == 'release'
         uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
         with:
           github-token: ${{ secrets.DOCS_WORKFLOW_TOKEN }}

CONTRIBUTING.md

@@ -126,4 +126,6 @@ uv run pytest
 * To contribute, ensure your docstrings follow the Google style format.
 * Once your docstring is correctly written, the documentation framework will scrape it and regenerate the corresponding `.mdx` files and your changes will then appear in the updated docs.
 * To contribute, examples/how-to-guides, make sure you submit clean notebooks, with cleared formatted LaTeX, links and images.
-* Make an appropriate entry in the `mint.json` file.
+* Make an appropriate entry in the `docs/mintlify/mint.json` file.
+* Run `make all_docs` to regenerate the documentation.
+* Run `make preview_docs` to view and test the documentation locally.