Files

T

Fusion 83f94b1f09 docs: comprehensive documentation overhaul

Add complete documentation structure:
- Frontend architecture documentation
- Database schema documentation
- Deployment guides (Docker, Traefik, Authentik, Environment)
- Development guides (Setup, Testing, Contributing, Quality Gates)
- Deployment architecture documentation
- Updated docs README with complete navigation

All new features and APIs are now documented.
Quality gates: docs only, no code changes

2026-05-19 14:18:20 +02:00

1.3 KiB

Raw Blame History

Feature Documentation Template

Use this template when documenting a new feature.

Feature Name

Overview

Provide a 1-2 sentence description of what this feature does and why it exists.

How to Use

Prerequisites

List any prerequisites (e.g., must be logged in, must have project created).

Step-by-Step Guide

Step 1: Description of first step
- Details
- Screenshots if applicable
Step 2: Description of second step
- Details
Step 3: Description of third step
- Details

Screenshots

Include screenshots or diagrams if they help understanding.

API Reference

List related API endpoints with links to API docs.

Endpoints

METHOD /endpoint/path - Brief description
METHOD /endpoint/path - Brief description

Configuration

List any relevant configuration options (environment variables, settings).

Option	Description	Default
`VAR_NAME`	What this controls	`default_value`

Troubleshooting

Common Issues

Issue: Description of problem Solution: How to fix it

Feature Name - How this relates
Feature Name - How this relates

1.3 KiB Raw Blame History