From 5187fd8de9525b002812a75ed0962d411e96f830 Mon Sep 17 00:00:00 2001 From: ZTatman Date: Fri, 24 Apr 2026 13:39:00 -0400 Subject: [PATCH] Organize docs and examples - Centralize examples in /examples folder - Fix README broken reference to docker-compose.example.yml - Rename design docs (remove date prefixes) --- README.md | 3 +-- ...auth-and-deployment-design.md => auth-deployment-design.md} | 0 docs/plans/{2026-03-30-phase-1-design.md => phase-1-design.md} | 0 {web => examples}/.env.example | 0 {packages/cli/examples => examples}/myst.config.example.json | 0 5 files changed, 1 insertion(+), 2 deletions(-) rename docs/plans/{2026-03-31-myst-auth-and-deployment-design.md => auth-deployment-design.md} (100%) rename docs/plans/{2026-03-30-phase-1-design.md => phase-1-design.md} (100%) rename {web => examples}/.env.example (100%) rename {packages/cli/examples => examples}/myst.config.example.json (100%) diff --git a/README.md b/README.md index baa2ab8..84d6c35 100644 --- a/README.md +++ b/README.md @@ -60,8 +60,7 @@ Prompts for: ### 2. Deploy with Docker Compose ```bash -cd packages/cli/examples -cp docker-compose.example.yml docker-compose.yml +cp examples/.env.example .env # Edit .env with your FORGEJO_BASE_URL and FORGEJO_PAT docker compose up -d ``` diff --git a/docs/plans/2026-03-31-myst-auth-and-deployment-design.md b/docs/plans/auth-deployment-design.md similarity index 100% rename from docs/plans/2026-03-31-myst-auth-and-deployment-design.md rename to docs/plans/auth-deployment-design.md diff --git a/docs/plans/2026-03-30-phase-1-design.md b/docs/plans/phase-1-design.md similarity index 100% rename from docs/plans/2026-03-30-phase-1-design.md rename to docs/plans/phase-1-design.md diff --git a/web/.env.example b/examples/.env.example similarity index 100% rename from web/.env.example rename to examples/.env.example diff --git a/packages/cli/examples/myst.config.example.json b/examples/myst.config.example.json similarity index 100% rename from packages/cli/examples/myst.config.example.json rename to examples/myst.config.example.json