Docs HTML

.env.example

@@ -10,7 +10,7 @@ XAI_API_KEY=your-xai-key-here
 # Z AI API Key (required for GLM-4.5 models)
 ZAI_API_KEY=your-zai-key-here
 
-# Anthropic API Key (required for Claude models)
+# Anthropic API Key (required for Claude models -- comment out if using Anthropic local login instead)
 ANTHROPIC_API_KEY=your-anthropic-key-here
 
 # Google Gemini API Key
@@ -34,3 +34,5 @@ NEBIUS_API_KEY=your-nebius-key-here
 # OPENROUTER API Key
 OPENROUTER_API_KEY=your-openrouter-key-here
 
+# KIMI API KEY
+MOONSHOT_API_KEY=your-kimi-key-here

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,48 @@
+---
+name: Bug Report
+about: Create a report to help us improve MassGen
+title: "[BUG] "
+labels: bug
+assignees: ''
+
+---
+
+## Bug Description
+<!-- A clear and concise description of what the bug is -->
+
+## To Reproduce
+<!-- Steps to reproduce the behavior -->
+1. Configuration file used:
+2. Command run:
+3. Input provided:
+4. Error seen:
+
+## Expected Behavior
+<!-- A clear and concise description of what you expected to happen -->
+
+## Actual Behavior
+<!-- Describe what actually happened -->
+
+## Screenshots
+<!-- If applicable, add screenshots to help explain your problem -->
+
+## Environment
+ - OS: [e.g., macOS, Linux, Windows]
+ - Python Version: [e.g., 3.9, 3.10, 3.11]
+ - MassGen Version: [e.g., 0.0.23]
+ - LLM Backend Used: [e.g., OpenAI, Claude, Gemini, Grok]
+
+## Configuration File
+<!-- If relevant, paste your configuration file content (please remove any sensitive information like API keys) -->
+```yaml
+# Your config file content
+```
+
+## Error Logs
+<!-- If there are error logs, please paste the relevant parts -->
+```
+# Error log content
+```
+
+## Additional Context
+<!-- Add any other context about the problem here -->

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Documentation
+    url: https://github.com/adithyagaurav/MassGen/blob/main/README.md
+    about: Check our documentation for usage guides and examples
+  - name: Discussions
+    url: https://github.com/adithyagaurav/MassGen/discussions
+    about: Ask questions and discuss ideas with the community
+  - name: Discord Community
+    url: https://discord.massgen.ai
+    about: Join our Discord for real-time support and discussions

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,32 @@
+---
+name: Feature Request
+about: Suggest an idea for MassGen
+title: "[FEATURE] "
+labels: enhancement
+assignees: ''
+
+---
+
+## Feature Description
+<!-- A clear and concise description of the feature you'd like -->
+
+## Motivation
+<!-- Explain why this feature would be useful for MassGen users -->
+
+## Proposed Solution
+<!-- Describe the solution you'd like to see implemented -->
+
+## Alternatives Considered
+<!-- Describe any alternative solutions or features you've considered -->
+
+## Use Cases
+<!-- Provide specific examples of how this feature would be used -->
+1.
+2.
+3.
+
+## Implementation Suggestions
+<!-- If you have ideas about how this could be implemented, share them here -->
+
+## Additional Context
+<!-- Add any other context, mockups, or examples about the feature request here -->

.github/pull_request_template.md

@@ -0,0 +1,59 @@
+## PR Title Format
+Your PR title must follow the format: `<type>: <brief description>`
+
+Valid types:
+- `fix:` - Bug fixes
+- `feat:` - New features
+- `breaking:` - Breaking changes
+- `docs:` - Documentation updates
+- `refactor:` - Code refactoring
+- `test:` - Test additions/modifications
+- `chore:` - Maintenance tasks
+- `perf:` - Performance improvements
+- `style:` - Code style changes
+- `ci:` - CI/CD configuration changes
+
+Examples:
+- `fix: resolve memory leak in data processing`
+- `feat: add export to CSV functionality`
+- `breaking: change API response format`
+- `docs: update installation guide`
+
+## Description
+Brief description of the changes in this PR
+
+## Type of change
+- [ ] Bug fix (`fix:`) - Non-breaking change which fixes an issue
+- [ ] New feature (`feat:`) - Non-breaking change which adds functionality
+- [ ] Breaking change (`breaking:`) - Fix or feature that would cause existing functionality to not work as expected
+- [ ] Documentation (`docs:`) - Documentation updates
+- [ ] Code refactoring (`refactor:`) - Code changes that neither fix a bug nor add a feature
+- [ ] Tests (`test:`) - Adding missing tests or correcting existing tests
+- [ ] Chore (`chore:`) - Maintenance tasks, dependency updates, etc.
+- [ ] Performance improvement (`perf:`) - Code changes that improve performance
+- [ ] Code style (`style:`) - Changes that do not affect the meaning of the code (formatting, missing semi-colons, etc.)
+- [ ] CI/CD (`ci:`) - Changes to CI/CD configuration files and scripts
+
+## Checklist
+- [ ] I have run pre-commit on my changed files and all checks pass
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+
+## Pre-commit status
+```
+# Paste the output of running pre-commit on your changed files:
+# uv run pre-commit install
+# git diff --name-only HEAD~1 | xargs uv run pre-commit run --files # for last commit
+# git diff --name-only origin/<base branch>...HEAD | xargs uv run pre-commit run --files # for all commits in PR
+# git add <your file> # if any fixes were applied
+# git commit -m "chore: apply pre-commit fixes"
+# git push origin <branch-name>
+```
+
+## Additional context
+Add any other context about the PR here.

.github/workflows/auto-release.yml

@@ -0,0 +1,125 @@
+# Steps to trigger the release:
+#   # 1. Switch to main branch
+#   git checkout main
+
+#   # 2. Ensure main is up to date
+#   git pull origin main
+
+#   # 3. Create tag
+#   git tag v1.0.0
+
+#   # 4. Push tag to remote
+#   git push origin v1.0.0
+
+name: Auto Release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*'
+      - 'v*.*.*-*'
+
+permissions:
+  contents: write
+  pull-requests: write
+  issues: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Get version from tag
+        id: version
+        run: |
+          echo "VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+          echo "VERSION_WITHOUT_V=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
+
+      - name: Generate changelog
+        id: changelog
+        run: |
+          # Get the previous tag
+          PREVIOUS_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "")
+
+          # Generate changelog between tags
+          if [ -z "$PREVIOUS_TAG" ]; then
+            echo "CHANGELOG<<EOF" >> $GITHUB_OUTPUT
+            echo "## What's Changed" >> $GITHUB_OUTPUT
+            echo "" >> $GITHUB_OUTPUT
+            echo "Initial release 🎉" >> $GITHUB_OUTPUT
+            echo "EOF" >> $GITHUB_OUTPUT
+          else
+            echo "CHANGELOG<<EOF" >> $GITHUB_OUTPUT
+            echo "## What's Changed" >> $GITHUB_OUTPUT
+            echo "" >> $GITHUB_OUTPUT
+
+            # Get commit messages
+            git log ${PREVIOUS_TAG}..HEAD --pretty=format:"* %s by @%an in %h" | while read line; do
+              echo "$line" >> $GITHUB_OUTPUT
+            done
+
+            echo "" >> $GITHUB_OUTPUT
+            echo "" >> $GITHUB_OUTPUT
+            echo "**Full Changelog**: https://github.com/${{ github.repository }}/compare/${PREVIOUS_TAG}...${{ steps.version.outputs.VERSION }}" >> $GITHUB_OUTPUT
+            echo "EOF" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Build distribution
+        run: |
+          python -m build
+          ls -la dist/
+
+      - name: Create GitHub Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.version.outputs.VERSION }}
+          release_name: Release ${{ steps.version.outputs.VERSION }}
+          body: |
+            # Release ${{ steps.version.outputs.VERSION }}
+
+            ${{ steps.changelog.outputs.CHANGELOG }}
+
+            ## Installation
+
+            You can install this version directly from the source:
+            ```bash
+            pip install git+https://github.com/${{ github.repository }}@${{ steps.version.outputs.VERSION }}
+            ```
+
+            Or download the source code and install locally:
+            ```bash
+            tar -xzf <archive>.tar.gz
+            cd <directory>
+            pip install .
+            ```
+          draft: false
+          prerelease: ${{ contains(steps.version.outputs.VERSION, '-') }}
+
+      - name: Post release summary
+        run: |
+          echo "### 🎉 Release ${{ steps.version.outputs.VERSION }} Created Successfully!" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "**Release URL**: https://github.com/${{ github.repository }}/releases/tag/${{ steps.version.outputs.VERSION }}" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "**Assets**:" >> $GITHUB_STEP_SUMMARY
+          echo "- Source code (tar.gz)" >> $GITHUB_STEP_SUMMARY
+          echo "- Source code (zip)" >> $GITHUB_STEP_SUMMARY
+          ls -la dist/ | grep -E "\.(tar\.gz|whl)$" | awk '{print "- "$9}' >> $GITHUB_STEP_SUMMARY

.github/workflows/docs.yml

@@ -0,0 +1,86 @@
+name: Build and Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+      - doc_web  # Your current branch
+    paths:
+      - 'docs/**'
+      - 'massgen/**/*.py'  # Rebuild on code changes for API docs
+      - '.github/workflows/docs.yml'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+  workflow_dispatch:  # Allow manual trigger
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements-docs.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r docs/requirements-docs.txt
+          pip install -e .  # Install MassGen for API documentation
+
+      - name: Build documentation
+        run: |
+          cd docs
+          make html
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/build/html
+
+  deploy:
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/doc_web')
+    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@v4
+
+  deploy-readthedocs:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Trigger Read the Docs build
+        run: |
+          curl -X POST \
+            -H "Authorization: Token ${{ secrets.READTHEDOCS_TOKEN }}" \
+            https://readthedocs.org/api/v3/projects/massgen/versions/latest/builds/
+        continue-on-error: true  # Don't fail if RTD is not set up yet