Documentation Structure for the Project

Problem

As the project grows, new contributors and users who want to self-host need a clear guide to understand the architecture and setup process. Currently, this information is not centralized or formalized.

Proposed Solution

Adopt a robust documentation standard by creating a /docs folder at the project root to house all technical and user-facing documentation. This approach makes maintenance, collaboration, and future translations easier.

Suggested Structure

/docs
ARCHITECTURE.md
SELF_HOSTING_GUIDE.md
/README.md
/CONTRIBUTING.md

• ARCHITECTURE.md: Explains the layers of Flutter Clean Architecture (data, domain, presentation, etc.) and their responsibilities.
• SELF_HOSTING_GUIDE.md:
  • Clearly states that the default LibreSpeed URL is for demonstration only.
  • Provides instructions to set up a personal LibreSpeed server.
  • Explains how to point the app to the new server using environment variables (.env).

To facilitate future translations, consider creating subfolders like docs/pt-BR/, docs/es/, etc.

Updates to Main Files

Add links to the new documents in README.md and CONTRIBUTING.md:

• Architecture Guide
• Self-Hosting Guide

Acceptance Criteria

• A new /docs folder is created at the project root.
• The ARCHITECTURE.md file details the architecture layers and responsibilities.
• The SELF_HOSTING_GUIDE.md explains about LibreSpeed, how to set up your own server, and how to point the app to it.
• README.md and CONTRIBUTING.md include links to the new documentation.
• (Optional) Structure is ready for documentation internationalization.