From 9e74cff388c2195ea083533715c5cbe4e80f82b7 Mon Sep 17 00:00:00 2001 From: javsper Date: Wed, 17 Jun 2026 05:10:58 -0400 Subject: [PATCH] docs: add docs/ index --- README.md | 2 +- docs/README.md | 13 +++++++++++++ DEPLOYMENT.md => docs/deployment.md | 2 +- 3 files changed, 15 insertions(+), 2 deletions(-) create mode 100644 docs/README.md rename DEPLOYMENT.md => docs/deployment.md (98%) diff --git a/README.md b/README.md index 969b755..aec153b 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,7 @@ Frontend deploys to **Vercel**, backend (with managed Postgres) deploys to The repo includes a [`render.yaml`](./render.yaml) blueprint so Render provisions the backend and the database in one click. -See [DEPLOYMENT.md](./DEPLOYMENT.md) for the step-by-step guide. +See [docs/deployment.md](./docs/deployment.md) for the step-by-step guide. ## Notes diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..122a068 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,13 @@ +# Documentation + +Project documentation for the Forgeng monorepo. For setup and a high-level +overview, start with the [root README](../README.md). + +## Contents + +- **[deployment.md](./deployment.md)** — How the frontend (Vercel) and backend + (Render + Postgres) deploy, environment variables, and free-tier caveats. +- **[student-features.md](./student-features.md)** — Feature proposals for the + student portal, grounded in the current code and data model. +- **[admin-completion-todo.md](./admin-completion-todo.md)** — Working TODO for + wiring up admin actions against the backend. diff --git a/DEPLOYMENT.md b/docs/deployment.md similarity index 98% rename from DEPLOYMENT.md rename to docs/deployment.md index d5513c5..7a9f4b8 100644 --- a/DEPLOYMENT.md +++ b/docs/deployment.md @@ -47,7 +47,7 @@ URL automatically. ## 2. Backend → Render -The repo ships with a [`render.yaml`](./render.yaml) blueprint that +The repo ships with a [`render.yaml`](../render.yaml) blueprint that provisions the web service and the Postgres database in one click. ### One-time setup