Skip to content

v2.4.0

Choose a tag to compare

View all tags
@github-actions github-actions released this 04 Dec 21:15
· 22 commits to main since this release
v2.4.0
33de941

v2.4.0 (2025-12-04)

This release is published under the MIT License.

Documentation

  • Add product planning documentation (12706f1)

  • Add mission.md with product vision, target users, and key features

  • Add roadmap.md with GitHub issues backlog and strategic features

  • Add tech-stack.md documenting complete technical stack

Incorporates 10 open issues from GitHub project board prioritized into immediate backlog and forward-looking strategic features.

  • Add requirements for user documentation spec (1fb4333)

Document comprehensive requirements including:

  • Target audience: beginners with progressive disclosure
  • Documentation structure: new sections + expanded existing files
  • Content scope: quickstart, tutorials, examples, troubleshooting
  • Technical format: Markdown with MyST, Furo theme
  • Clear exclusions: backend installation, IaC, monitoring

Requirements gathered through user clarification and codebase analysis.

  • Create comprehensive user documentation spec (24da4d7)

Add detailed specification for beginner-friendly user documentation:

  • Quickstart tutorial and extended examples
  • 8 backend reference pages (Gunicorn, Granian, Uvicorn, Waitress, Celery, etc.)
  • Practical guides: Docker, environment configs, multi-process setup
  • Troubleshooting guide with common issues
  • ARGS to CLI argument translation for all backends
  • Progressive disclosure pattern for beginners
  • Leverages existing Sphinx/Furo/MyST infrastructure

Success criteria includes 10-minute quickstart and complete backend coverage.

  • Create tasks breakdown for user documentation (e851d0f)

Add comprehensive tasks list with 7 groups and 45 sub-tasks:

  • Infrastructure setup (directories, indexes, TOC)
  • Core documentation updates (installation, usage, configuration)
  • Priority backend references (Gunicorn, Celery, Uvicorn)
  • Additional backend references (Granian, Waitress, Django Tasks, Django-Q2)
  • Practical guides (quickstart, Docker, environments, multi-process, switching)
  • Troubleshooting guide (10+ common issues)
  • Integration, testing, and polish (cross-refs, build validation)

Tasks ordered by priority: quickstart → popular backends → guides → polish. Success criteria: <10min quickstart, complete backend coverage, zero Sphinx warnings.

  • Implement comprehensive user documentation (7d07706)

Complete implementation of all 7 task groups (45 sub-tasks):

DOCUMENTATION CREATED: - 8 backend reference pages (Gunicorn, Celery, Uvicorn, Granian, Waitress, Django Tasks, Django-Q2) - 6 practical guides (Quickstart, Docker, Environment Configs, Multi-Process, Backend Switching) - 1 troubleshooting guide (35+ issues covered) - Enhanced core docs (installation.md, usage.md, configuration.rst) - Updated main index with new sections

KEY FEATURES: - Beginner-friendly with progressive disclosure - ARGS → CLI translation for all backends - Copy-paste ready code examples - MyST cross-references throughout - Docker, systemd, and Docker Compose examples - Environment-specific configurations - 7,074 total lines of documentation

VERIFICATION: - Sphinx build: SUCCESS - Test suite: 171/171 tests passing - All success criteria met (18/18) - Cross-references working - External links validated - Quickstart accessible within 2 clicks

Total content: 8 backend pages, 6 guides, 1 troubleshooting guide, 4 updated core files

  • Initialize spec for comprehensive user documentation (ec6dd1a)

Create spec folder for comprehensive user documentation feature:

  • Installation & configuration guide
  • Command reference (prodserver, devserver)
  • Backend documentation with configuration mapping
  • PRODUCTION_PROCESSES settings reference

Spec includes planning folder structure with raw-idea.md and visuals folder.

  • Make the docs more concise (45252c6)

Features

Detailed Changes: v2.3.0...v2.4.0

Assets 6
Loading