Sync v2-dev with main: Comprehensive Documentation and Theme Updates

.github/workflows/optimize-images.yml

@@ -0,0 +1,52 @@
+name: Optimize Images
+
+on:
+  pull_request:
+    paths:
+      - '**.png'
+      - '**.jpg'
+      - '**.jpeg'
+      - 'docs/assets/**'
+
+jobs:
+  optimize:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install optimization tools
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y pngquant optipng jpegoptim webp
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      - name: Install Python dependencies
+        run: |
+          pip install pillow
+
+      - name: Optimize images
+        run: |
+          python scripts/optimize_images.py
+
+      - name: Check if images were optimized
+        id: check_changes
+        run: |
+          if [[ -n $(git status --porcelain) ]]; then
+            echo "changes=true" >> $GITHUB_OUTPUT
+          else
+            echo "changes=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Commit optimized images
+        if: steps.check_changes.outputs.changes == 'true'
+        uses: EndBug/add-and-commit@v9
+        with:
+          message: 'Optimize images [skip ci]'
+          add: '*.png *.jpg *.jpeg *.webp'
+          committer_name: 'GitHub Actions'
+          committer_email: 'actions@github.com'

.gitignore

@@ -142,7 +142,26 @@ Thumbs.db
 
 # Project specific
 schema.json
+
+# AI tools and configuration files
+CLAUDE.md
 CLAUDE.local.md
+.claude/
+.cursor/
+.cursorrules
+.github/copilot-instructions.md
+.aider*
+.codeium/
+.gemini/
+.anthropic/
+claude-*
+anthropic-*
+openai-*
+*.aider.log
+
+# Development and planning files (keep local only)
+COMMIT_HISTORY_CLEANUP.md
+PHASE2_DEVELOPMENT_PLAN.md
 
 # Coverage reports
 htmlcov/

.readthedocs.yml

@@ -0,0 +1,39 @@
+# Read the Docs configuration file for ESO Logs Python
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+# Set the OS, set of tools, and language to use
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+  jobs:
+    post_checkout:
+      # Cancel building pull requests when there aren't changes in the docs directory or YAML file.
+      # You can add any other files or directories that you'd like here as well,
+      # like your docs requirements file, or other files that will change your docs build.
+      - |
+        if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/v2/update-main-before-refactor HEAD -- docs/ .readthedocs.yml requirements.txt; then
+          echo "No documentation changes found in PR, cancelling build."
+          exit 183
+        fi
+
+# Build documentation with MkDocs
+mkdocs:
+  configuration: mkdocs.yml
+  fail_on_warning: false
+
+# Python configuration
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+
+# Formats to build
+formats:
+  - pdf
+  - htmlzip

BRANCH_STRUCTURE.md

@@ -6,7 +6,8 @@ This document outlines the branch structure and purpose for the esologs-python r
 
 | Branch | API Version | Status | Authentication | Features | Use Case |
 |--------|-------------|--------|----------------|----------|----------|
-| `v2-dev` | v2 GraphQL | ✅ Active | OAuth2 | Full modern stack | **Use this** |
+| `v2/update-main-before-refactor` | v2 GraphQL | ✅ Active | OAuth2 | Full API docs + comprehensive testing | **Use this** |
+| `v2-dev` | v2 GraphQL | 📦 Archived | OAuth2 | Previous dev branch | **Historical** |
 | `main` | v2 GraphQL | ⚠️ Syncing | OAuth2 | Production ready | **Stable** |
 | `v1-api` | v1 REST | 🔒 Archived | API Key | Legacy scripts | **Archive only** |
 
@@ -16,7 +17,7 @@ This document outlines the branch structure and purpose for the esologs-python r
 ```bash
 git clone https://github.com/knowlen/esologs-python.git
 cd esologs-python
-git checkout v2-dev
+git checkout v2/update-main-before-refactor
 pip install -e ".[dev]"
 ```
 
@@ -28,18 +29,24 @@ git checkout v1-api
 
 ## 🌟 Active Development Branches
 
-### `v2-dev` (Primary Development Branch)
-- **Purpose**: Main development branch for v2 API implementation
+### `v2/update-main-before-refactor` (Primary Development Branch)
+- **Purpose**: Current active development branch with complete API documentation
 - **Status**: ✅ Active development
 - **Features**:
-  - Modern ESO Logs v2 GraphQL API implementation
+  - Modern ESO Logs v2 GraphQL API implementation (~75% coverage)
+  - Complete API reference documentation for all endpoints
+  - Comprehensive test suite (203+ tests across unit/integration/docs/sanity)
   - OAuth2 authentication
   - pyproject.toml packaging
-  - Unit testing framework
   - Code quality tools (black, isort, ruff, mypy)
   - Pre-commit hooks
 - **Use**: All new development should happen here
 
+### `v2-dev` (Previous Development Branch)
+- **Purpose**: Previous main development branch
+- **Status**: 📦 Archived - superseded by v2/update-main-before-refactor
+- **Use**: Historical reference only
+
 ## 📜 Archive Branches
 
 ### `main`
@@ -62,17 +69,17 @@ git checkout v1-api
 ## 📋 Branch Usage Guidelines
 
 ### For Contributors
-- **Start new work**: Always branch from `v2-dev`
-- **Create PRs**: Target `v2-dev` branch
+- **Start new work**: Always branch from `v2/update-main-before-refactor`
+- **Create PRs**: Target `v2/update-main-before-refactor` branch
 - **Naming**: Use descriptive branch names like `feature/character-rankings` or `fix/authentication-bug`
 
 ### For Users
-- **Current development**: Use `v2-dev` branch
+- **Current development**: Use `v2/update-main-before-refactor` branch
 - **Stable code**: Wait for main branch migration (coming soon)
 - **Historical reference**: `v1-api` branch (deprecated, do not use)
 
 
 ---
 
-**Last Updated**: July 9, 2025
-**Documentation**: This file is maintained in the `v2-dev` branch
+**Last Updated**: July 13, 2025
+**Documentation**: This file is maintained in the `v2/update-main-before-refactor` branch