Gezen Backend Docs

Welcome to the public documentation site for the Gezen Backend (Sword API).

This site is designed for people who need to understand, deploy, or maintain the backend without digging through the codebase first.

What you’ll find here

• Deployment guides for production and local HTTPS setups
• Operational notes for environment variables, logs, and maintenance
• Architecture and analysis notes that explain technical debt and design decisions

Quick links

• Production Deployment
• Local Deployment
• Code Analysis
• Analysis Report
• Load Testing

Public API reference

The interactive API reference remains available in the application itself:

• Swagger UI: /api/docs
• ReDoc: /api/redoc

Contributing to docs

If you update any page under docs/, push your changes to main. A GitHub Actions workflow will build the site and publish it to GitHub Pages.

For local preview, run:

pip install -r requirements/docs.txt
mkdocs serve