Merge pull request #5 from vaizcom/docs

Docs

Author: m-brtn

.github/workflows/deploy-docs.yml

@@ -0,0 +1,60 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs-site/**'
+      - '.github/workflows/deploy-docs.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs-site
+    
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: 'npm'
+          cache-dependency-path: docs-site/package-lock.json
+      
+      - name: Install dependencies
+        run: npm ci
+      
+      - name: Build documentation
+        run: npm run build
+      
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs-site/build
+
+  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@v4
+

.gitignore

@@ -19,56 +19,38 @@ wheels/
 *.egg-info/
 .installed.cfg
 *.egg
-
-# Virtual Environment
+MANIFEST
 venv/
-env/
 ENV/
-.env
-.venv
-env.bak/
-venv.bak/
-
-# IDE
-.idea/
-.vscode/
-*.swp
-*.swo
-.DS_Store
+env/
 
 # Testing
+.pytest_cache/
 .coverage
 htmlcov/
-.pytest_cache/
-.tox/
-.nox/
-coverage.xml
-*.cover
-.hypothesis/
-
-# Distribution
-*.tar.gz
-*.zip
 
-# Logs
-*.log
-logs/
-log/
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
 
-# Local development
+# Environment
+.env
 .env.local
-.env.development.local
-.env.test.local
-.env.production.local
 
-# Documentation
-docs/_build/
-site/
+# OS
+.DS_Store
+Thumbs.db
 
-# Jupyter Notebook
-.ipynb_checkpoints
+# Docusaurus
+docs-site/node_modules/
+docs-site/build/
+docs-site/.docusaurus/
+docs-site/.cache-loader/
 
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
+# Package distribution
+dist/
+*.whl
+*.tar.gz

CHANGELOG.md

@@ -1,5 +1,41 @@
 # Changelog
 
+## [0.6.0] - 2025-10-20
+
+### Breaking Changes
+
+- **🔗 Renamed Task Connector Fields** for better clarity:
+  - `right_connectors` → `blocking` (tasks that this task blocks)
+  - `left_connectors` → `blockers` (tasks that block this task)
+  - API mapping is automatic - SDK uses intuitive names, API receives technical names
+  - **Migration**: Replace `rightConnectors` with `blocking` and `leftConnectors` with `blockers` in your code
+
+### Added
+
+- **📚 Complete Docusaurus Documentation**: Full documentation site with:
+  - Getting Started guide
+  - Complete API Reference for all endpoints
+  - Task Blockers documentation
+  - Helper Functions reference
+  - Practical examples
+  - Contributing guide
+- **🔗 Task Blockers API**: New documentation page explaining blocker relationships
+- **📖 Comprehensive Examples**: Updated all code examples with new field names
+
+### Changed
+
+- **Documentation**: Moved from README to dedicated Docusaurus site
+- **README**: Simplified to quick start guide with links to full documentation
+- **CONTRIBUTING.md**: Moved to project root as standard practice
+
+### Documentation
+
+- Site: https://vaiz-python-sdk.vercel.app
+- Getting Started: https://vaiz-python-sdk.vercel.app/getting-started
+- API Reference: https://vaiz-python-sdk.vercel.app/api/overview
+
+---
+
 ## [0.5.0] - 2025-09-17
 
 ### Added