From 2e8a558b71926d1be7e133d5819d6c514ae6e102 Mon Sep 17 00:00:00 2001 From: Fusion Date: Thu, 14 May 2026 01:47:03 +0200 Subject: [PATCH] fix(FN-002): remove forward references from docs to files not yet created --- docs/README.md | 6 +++--- docs/deployment.md | 2 ++ docs/development.md | 12 +++++++----- 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/README.md b/docs/README.md index 2e905ed..872e746 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,6 +10,6 @@ This directory contains architecture, development, and deployment documentation ## Quick Links -- [Root README](../README.md) -- [Deploy Skeleton](../deploy/README.md) -- [Project Brief](project-brief.md) — Original product brief and confirmed stack +- Root README — to be added in Step 6 +- Deploy Skeleton — to be added in Step 5 +- [Project Brief](project-brief.md) — Original product brief and confirmed stack *(FN-001)* diff --git a/docs/deployment.md b/docs/deployment.md index eb59e09..e2206f1 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -16,6 +16,8 @@ This document covers the scaffold-level deployment assumptions created in FN-002 ## Deployment Files +The following files will be added as part of the Docker Compose skeleton (Step 5): + | File | Purpose | |------|---------| | `docker-compose.yml` | Local development (API, web, Postgres) | diff --git a/docs/development.md b/docs/development.md index 010964d..99b132e 100644 --- a/docs/development.md +++ b/docs/development.md @@ -55,9 +55,11 @@ pnpm dev # Runs frontend and backend in parallel ### With Docker Compose -```bash -docker compose up --build -d -``` +> Docker Compose files will be added in Step 5. Once created, run: +> +> ```bash +> docker compose up --build -d +> ``` ## Testing @@ -127,8 +129,8 @@ pnpm build │ ├── web/ # Vite React TypeScript frontend │ └── api/ # FastAPI Python backend ├── docs/ # Documentation -├── deploy/ # Deployment skeleton files -├── docker-compose.yml +├── deploy/ # Deployment skeleton files (added in Step 5) +├── docker-compose.yml (added in Step 5) └── package.json # Root monorepo scripts ```