Merge branch 'develop' for docs publish

Author: yangchenlarkin

.github/workflows/docs.yml

@@ -0,0 +1,44 @@
+name: Docs
+
+on:
+  push:
+    branches: [ main ]
+    tags: [ 'v*' ]
+  workflow_dispatch:
+
+jobs:
+  build-and-deploy:
+    name: Build and Deploy API Docs
+    runs-on: macos-latest
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+
+    - name: Show Environment
+      run: |
+        xcodebuild -version
+        swift --version
+
+    - name: Install Jazzy
+      run: |
+        sudo gem install jazzy --no-document
+        jazzy --version
+
+    - name: Generate Docs
+      run: bash Scripts/generate-docs.sh
+
+    - name: Upload Docs Artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: api-docs
+        path: docs
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs
+        publish_branch: gh-pages
+        force_orphan: true
+

.gitignore

@@ -1,3 +1,4 @@
+docs/
 ### Swift Package Manager ###
 .build/
 .swiftpm/

.jazzy.yaml

@@ -0,0 +1,16 @@
+author: Larkin
+author_url: mailto:yangchenlarkin@gmail.com
+github_url: https://github.com/yangchenlarkin/Monstra
+module: Monstra
+module_version: 0.0.9
+swift_build_tool: spm
+theme: apple
+min_acl: public
+readme: README.md
+output: docs
+clean: true
+exclude:
+  - Examples
+  - Tests
+  - .build
+

README.md

@@ -10,6 +10,8 @@
 
 A high-performance Swift framework providing efficient task execution, memory caching, and data management utilities with intelligent execution merging, TTL caching, and retry logic.
 
+Documentation: [API Reference (Jazzy)](https://yangchenlarkin.github.io/Monstra/)  
+
 ## 🚀 Features
 
 ### Monstore - Caching System

Scripts/generate-docs.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+echo "Generating Jazzy docs..."
+jazzy --clean --config .jazzy.yaml
+echo "Docs generated under ./docs"
+