Background

During the discussion about ERPNext documentation, #1793 I just linked to a documentation framework called Diataxis. While completing the VitePress based Documentation site, I happen to notice that the documentation is actually in a poor form, and it is very difficult for a new user to learn and get started with Containerised Frappe.

The Proposal

This is a request for comments, regarding restructuring and rewriting the documentation to make it more user friendly and easy to explore. A two phase approach is proposed where the first phase is adapting a better organisation of pages, and the second phase will be rewriting documentation pages to improve quality. Below I'm adding a new proposed structure for docs based on the Diataxis framework I mentioned above.

Points to note

1. Some pages are renamed to clearly convey what it contains. Current names of these pages, in a compressed form, are given in the parenthesis along with new name.
2. Some pages are combined together because the content is mostly same or very close. These are marked by specifying a + between the page names.
3. The following list mainly shows the compressed name of the name of the page will be shown in the sidebar of VitePress Documentation. Which means more detailed titles can be specified in the page.

Proposed Structure

# Explanations and Concepts 1. Overview 2. Choosing a Method 3. Container Immutability 4. Frappe Concepts 5. FAQ # Guides and Manuals 1. Quick Start on Unix Systems 2. Local Development Setup 3. Easy Install Script 4. Build Images (Build Setup) 5. Initialising Site (Start Container) + Site Operations 6. Creating Backups 7. Multi Bench Setup (Single Server Setup) + NGINX and ACME Companion 8. Caddy With HTTPS 9. Migrate From Multi Image Setup 10. Migrate Traefik from v2 to v3 11. PostgreSQL Upgrade 12. Troubleshooting Guides + NGINX in Windows + ARM64 / Apple Silicon # Lessons and Tutorials 2. Play with Docker (Single Compose Setup) 3. Setup Examples 4. Multi Bench Example 5. Multi Tenant Setup # Reference 1. Production Overview (Setup Overview) 2. Environment Variables 3. Compose Overrides 4. TLS/SSL Overview 5. Setting Up Debugger (Debugging) 6. Local Services 7. Configuring VitePress 8. Fork Management 9. Framework Comparisons 10. External Links