From cab78405cc8f77494d95ce3b2a1e786336eb2f11 Mon Sep 17 00:00:00 2001 From: adithya Date: Sat, 7 Feb 2026 00:17:38 +0530 Subject: [PATCH] refactor: Moving md files to src for clarity --- docs/.vitepress/config.mts | 5 +++-- docs/package.json | 11 ++++++----- .../01-choosing-a-deployment-method.md | 4 ++-- .../01-getting-started/02-docker-immutability.md | 0 docs/{ => src}/01-getting-started/03-arm64.md | 0 .../01-getting-started/04-single-compose-setup.md | 0 docs/{ => src}/01-getting-started/index.md | 0 docs/{ => src}/02-setup/01-overview.md | 0 docs/{ => src}/02-setup/02-build-setup.md | 0 docs/{ => src}/02-setup/03-start-setup.md | 0 docs/{ => src}/02-setup/04-env-variables.md | 0 docs/{ => src}/02-setup/05-overrides.md | 0 docs/{ => src}/02-setup/06-setup-examples.md | 0 docs/{ => src}/02-setup/07-single-server-example.md | 0 .../02-setup/08-single-server-nginxproxy-example.md | 0 docs/{ => src}/02-setup/index.md | 0 docs/{ => src}/03-production/01-tls-ssl-setup.md | 0 docs/{ => src}/03-production/02-backup-strategy.md | 0 docs/{ => src}/03-production/03-multi-tenancy.md | 0 .../03-production/04-nginx-proxy-acme-companion.md | 0 docs/{ => src}/03-production/05-caddy-https.md | 0 docs/{ => src}/03-production/index.md | 0 docs/{ => src}/04-operations/01-site-operations.md | 0 docs/{ => src}/04-operations/index.md | 0 docs/{ => src}/05-development/01-development.md | 0 docs/{ => src}/05-development/02-debugging.md | 0 .../05-development/03-local-services-connection.md | 0 docs/{ => src}/05-development/index.md | 0 .../01-migrate-from-multi-image-setup.md | 0 .../06-migration/02-traefik-v3-migration.md | 0 docs/{ => src}/06-migration/index.md | 0 .../{ => src}/07-troubleshooting/01-troubleshoot.md | 0 .../02-windows-nginx-entrypoint-error.md | 0 docs/{ => src}/07-troubleshooting/index.md | 0 .../08-reference/01-build-version-10-images.md | 0 docs/{ => src}/08-reference/index.md | 0 docs/{ => src}/getting-started.md | 0 ...ocker Desktop Screenshot - Resources section.png | Bin ...Docker Manual Screenshot - Resources section.png | Bin docs/{ => src}/index.md | 0 40 files changed, 11 insertions(+), 9 deletions(-) rename docs/{ => src}/01-getting-started/01-choosing-a-deployment-method.md (96%) rename docs/{ => src}/01-getting-started/02-docker-immutability.md (100%) rename docs/{ => src}/01-getting-started/03-arm64.md (100%) rename docs/{ => src}/01-getting-started/04-single-compose-setup.md (100%) rename docs/{ => src}/01-getting-started/index.md (100%) rename docs/{ => src}/02-setup/01-overview.md (100%) rename docs/{ => src}/02-setup/02-build-setup.md (100%) rename docs/{ => src}/02-setup/03-start-setup.md (100%) rename docs/{ => src}/02-setup/04-env-variables.md (100%) rename docs/{ => src}/02-setup/05-overrides.md (100%) rename docs/{ => src}/02-setup/06-setup-examples.md (100%) rename docs/{ => src}/02-setup/07-single-server-example.md (100%) rename docs/{ => src}/02-setup/08-single-server-nginxproxy-example.md (100%) rename docs/{ => src}/02-setup/index.md (100%) rename docs/{ => src}/03-production/01-tls-ssl-setup.md (100%) rename docs/{ => src}/03-production/02-backup-strategy.md (100%) rename docs/{ => src}/03-production/03-multi-tenancy.md (100%) rename docs/{ => src}/03-production/04-nginx-proxy-acme-companion.md (100%) rename docs/{ => src}/03-production/05-caddy-https.md (100%) rename docs/{ => src}/03-production/index.md (100%) rename docs/{ => src}/04-operations/01-site-operations.md (100%) rename docs/{ => src}/04-operations/index.md (100%) rename docs/{ => src}/05-development/01-development.md (100%) rename docs/{ => src}/05-development/02-debugging.md (100%) rename docs/{ => src}/05-development/03-local-services-connection.md (100%) rename docs/{ => src}/05-development/index.md (100%) rename docs/{ => src}/06-migration/01-migrate-from-multi-image-setup.md (100%) rename docs/{ => src}/06-migration/02-traefik-v3-migration.md (100%) rename docs/{ => src}/06-migration/index.md (100%) rename docs/{ => src}/07-troubleshooting/01-troubleshoot.md (100%) rename docs/{ => src}/07-troubleshooting/02-windows-nginx-entrypoint-error.md (100%) rename docs/{ => src}/07-troubleshooting/index.md (100%) rename docs/{ => src}/08-reference/01-build-version-10-images.md (100%) rename docs/{ => src}/08-reference/index.md (100%) rename docs/{ => src}/getting-started.md (100%) rename docs/{ => src}/images/Docker Desktop Screenshot - Resources section.png (100%) rename docs/{ => src}/images/Docker Manual Screenshot - Resources section.png (100%) rename docs/{ => src}/index.md (100%) diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 495139ae..42adf4b2 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -5,6 +5,7 @@ import { withSidebar } from "vitepress-sidebar"; const vitePressOptions = { title: "Frappe Docker Docs", description: "Frappe in a Container", + srcDir: "./src", base: "/frappe_docker/", themeConfig: { logo: "/frappe-docker.png", @@ -18,11 +19,11 @@ const vitePressOptions = { }; const vitePressSidebarOptions = { - documentRootPath: "./docs", + documentRootPath: ".", useTitleFromFrontmatter: true, useFolderTitleFromIndexFile: true, }; export default defineConfig( - withSidebar(vitePressOptions, vitePressSidebarOptions) + withSidebar(vitePressOptions, vitePressSidebarOptions), ); diff --git a/docs/package.json b/docs/package.json index a365f27f..32e71881 100644 --- a/docs/package.json +++ b/docs/package.json @@ -4,8 +4,9 @@ "vitepress-sidebar": "^1.33.1" }, "scripts": { - "docs:dev": "vitepress dev docs", - "docs:build": "vitepress build docs", - "docs:preview": "vitepress preview docs" - } -} \ No newline at end of file + "docs:dev": "vitepress dev", + "docs:build": "vitepress build", + "docs:preview": "vitepress preview" + }, + "packageManager": "pnpm@10.28.2+sha512.41872f037ad22f7348e3b1debbaf7e867cfd448f2726d9cf74c08f19507c31d2c8e7a11525b983febc2df640b5438dee6023ebb1f84ed43cc2d654d2bc326264" +} diff --git a/docs/01-getting-started/01-choosing-a-deployment-method.md b/docs/src/01-getting-started/01-choosing-a-deployment-method.md similarity index 96% rename from docs/01-getting-started/01-choosing-a-deployment-method.md rename to docs/src/01-getting-started/01-choosing-a-deployment-method.md index 11b39a8f..4b343c06 100644 --- a/docs/01-getting-started/01-choosing-a-deployment-method.md +++ b/docs/src/01-getting-started/01-choosing-a-deployment-method.md @@ -45,7 +45,7 @@ If you start with `pwd.yml`, you should expect to **throw the environment away** ## 2. VS Code Devcontainers – Local Development Setup -The development setup described in [`/docs/05-development`](../05-development) +The development setup described in [`/docs/05-development/development.md`](../05-development/01-development.md) uses **VS Code Devcontainers** to provide a **local Frappe development environment**. @@ -103,7 +103,7 @@ It uses: - The main `compose.yml` - Override files from the `overrides/` directory -Detailed instructions are available in [`/docs/02-setup`](../02-setup) +Detailed instructions are available in [`/docs/02-setup`](../02-setup/01-overview.md) ### Characteristics diff --git a/docs/01-getting-started/02-docker-immutability.md b/docs/src/01-getting-started/02-docker-immutability.md similarity index 100% rename from docs/01-getting-started/02-docker-immutability.md rename to docs/src/01-getting-started/02-docker-immutability.md diff --git a/docs/01-getting-started/03-arm64.md b/docs/src/01-getting-started/03-arm64.md similarity index 100% rename from docs/01-getting-started/03-arm64.md rename to docs/src/01-getting-started/03-arm64.md diff --git a/docs/01-getting-started/04-single-compose-setup.md b/docs/src/01-getting-started/04-single-compose-setup.md similarity index 100% rename from docs/01-getting-started/04-single-compose-setup.md rename to docs/src/01-getting-started/04-single-compose-setup.md diff --git a/docs/01-getting-started/index.md b/docs/src/01-getting-started/index.md similarity index 100% rename from docs/01-getting-started/index.md rename to docs/src/01-getting-started/index.md diff --git a/docs/02-setup/01-overview.md b/docs/src/02-setup/01-overview.md similarity index 100% rename from docs/02-setup/01-overview.md rename to docs/src/02-setup/01-overview.md diff --git a/docs/02-setup/02-build-setup.md b/docs/src/02-setup/02-build-setup.md similarity index 100% rename from docs/02-setup/02-build-setup.md rename to docs/src/02-setup/02-build-setup.md diff --git a/docs/02-setup/03-start-setup.md b/docs/src/02-setup/03-start-setup.md similarity index 100% rename from docs/02-setup/03-start-setup.md rename to docs/src/02-setup/03-start-setup.md diff --git a/docs/02-setup/04-env-variables.md b/docs/src/02-setup/04-env-variables.md similarity index 100% rename from docs/02-setup/04-env-variables.md rename to docs/src/02-setup/04-env-variables.md diff --git a/docs/02-setup/05-overrides.md b/docs/src/02-setup/05-overrides.md similarity index 100% rename from docs/02-setup/05-overrides.md rename to docs/src/02-setup/05-overrides.md diff --git a/docs/02-setup/06-setup-examples.md b/docs/src/02-setup/06-setup-examples.md similarity index 100% rename from docs/02-setup/06-setup-examples.md rename to docs/src/02-setup/06-setup-examples.md diff --git a/docs/02-setup/07-single-server-example.md b/docs/src/02-setup/07-single-server-example.md similarity index 100% rename from docs/02-setup/07-single-server-example.md rename to docs/src/02-setup/07-single-server-example.md diff --git a/docs/02-setup/08-single-server-nginxproxy-example.md b/docs/src/02-setup/08-single-server-nginxproxy-example.md similarity index 100% rename from docs/02-setup/08-single-server-nginxproxy-example.md rename to docs/src/02-setup/08-single-server-nginxproxy-example.md diff --git a/docs/02-setup/index.md b/docs/src/02-setup/index.md similarity index 100% rename from docs/02-setup/index.md rename to docs/src/02-setup/index.md diff --git a/docs/03-production/01-tls-ssl-setup.md b/docs/src/03-production/01-tls-ssl-setup.md similarity index 100% rename from docs/03-production/01-tls-ssl-setup.md rename to docs/src/03-production/01-tls-ssl-setup.md diff --git a/docs/03-production/02-backup-strategy.md b/docs/src/03-production/02-backup-strategy.md similarity index 100% rename from docs/03-production/02-backup-strategy.md rename to docs/src/03-production/02-backup-strategy.md diff --git a/docs/03-production/03-multi-tenancy.md b/docs/src/03-production/03-multi-tenancy.md similarity index 100% rename from docs/03-production/03-multi-tenancy.md rename to docs/src/03-production/03-multi-tenancy.md diff --git a/docs/03-production/04-nginx-proxy-acme-companion.md b/docs/src/03-production/04-nginx-proxy-acme-companion.md similarity index 100% rename from docs/03-production/04-nginx-proxy-acme-companion.md rename to docs/src/03-production/04-nginx-proxy-acme-companion.md diff --git a/docs/03-production/05-caddy-https.md b/docs/src/03-production/05-caddy-https.md similarity index 100% rename from docs/03-production/05-caddy-https.md rename to docs/src/03-production/05-caddy-https.md diff --git a/docs/03-production/index.md b/docs/src/03-production/index.md similarity index 100% rename from docs/03-production/index.md rename to docs/src/03-production/index.md diff --git a/docs/04-operations/01-site-operations.md b/docs/src/04-operations/01-site-operations.md similarity index 100% rename from docs/04-operations/01-site-operations.md rename to docs/src/04-operations/01-site-operations.md diff --git a/docs/04-operations/index.md b/docs/src/04-operations/index.md similarity index 100% rename from docs/04-operations/index.md rename to docs/src/04-operations/index.md diff --git a/docs/05-development/01-development.md b/docs/src/05-development/01-development.md similarity index 100% rename from docs/05-development/01-development.md rename to docs/src/05-development/01-development.md diff --git a/docs/05-development/02-debugging.md b/docs/src/05-development/02-debugging.md similarity index 100% rename from docs/05-development/02-debugging.md rename to docs/src/05-development/02-debugging.md diff --git a/docs/05-development/03-local-services-connection.md b/docs/src/05-development/03-local-services-connection.md similarity index 100% rename from docs/05-development/03-local-services-connection.md rename to docs/src/05-development/03-local-services-connection.md diff --git a/docs/05-development/index.md b/docs/src/05-development/index.md similarity index 100% rename from docs/05-development/index.md rename to docs/src/05-development/index.md diff --git a/docs/06-migration/01-migrate-from-multi-image-setup.md b/docs/src/06-migration/01-migrate-from-multi-image-setup.md similarity index 100% rename from docs/06-migration/01-migrate-from-multi-image-setup.md rename to docs/src/06-migration/01-migrate-from-multi-image-setup.md diff --git a/docs/06-migration/02-traefik-v3-migration.md b/docs/src/06-migration/02-traefik-v3-migration.md similarity index 100% rename from docs/06-migration/02-traefik-v3-migration.md rename to docs/src/06-migration/02-traefik-v3-migration.md diff --git a/docs/06-migration/index.md b/docs/src/06-migration/index.md similarity index 100% rename from docs/06-migration/index.md rename to docs/src/06-migration/index.md diff --git a/docs/07-troubleshooting/01-troubleshoot.md b/docs/src/07-troubleshooting/01-troubleshoot.md similarity index 100% rename from docs/07-troubleshooting/01-troubleshoot.md rename to docs/src/07-troubleshooting/01-troubleshoot.md diff --git a/docs/07-troubleshooting/02-windows-nginx-entrypoint-error.md b/docs/src/07-troubleshooting/02-windows-nginx-entrypoint-error.md similarity index 100% rename from docs/07-troubleshooting/02-windows-nginx-entrypoint-error.md rename to docs/src/07-troubleshooting/02-windows-nginx-entrypoint-error.md diff --git a/docs/07-troubleshooting/index.md b/docs/src/07-troubleshooting/index.md similarity index 100% rename from docs/07-troubleshooting/index.md rename to docs/src/07-troubleshooting/index.md diff --git a/docs/08-reference/01-build-version-10-images.md b/docs/src/08-reference/01-build-version-10-images.md similarity index 100% rename from docs/08-reference/01-build-version-10-images.md rename to docs/src/08-reference/01-build-version-10-images.md diff --git a/docs/08-reference/index.md b/docs/src/08-reference/index.md similarity index 100% rename from docs/08-reference/index.md rename to docs/src/08-reference/index.md diff --git a/docs/getting-started.md b/docs/src/getting-started.md similarity index 100% rename from docs/getting-started.md rename to docs/src/getting-started.md diff --git a/docs/images/Docker Desktop Screenshot - Resources section.png b/docs/src/images/Docker Desktop Screenshot - Resources section.png similarity index 100% rename from docs/images/Docker Desktop Screenshot - Resources section.png rename to docs/src/images/Docker Desktop Screenshot - Resources section.png diff --git a/docs/images/Docker Manual Screenshot - Resources section.png b/docs/src/images/Docker Manual Screenshot - Resources section.png similarity index 100% rename from docs/images/Docker Manual Screenshot - Resources section.png rename to docs/src/images/Docker Manual Screenshot - Resources section.png diff --git a/docs/index.md b/docs/src/index.md similarity index 100% rename from docs/index.md rename to docs/src/index.md