# Documentation Index

Use this index to find the right document. Start with the **Architecture Overview** for a high-level understanding of the project.

---

## Architecture

| Document | Description |
|----------|-------------|
| [architecture-overview.html](architecture-overview.html) | **Start here** — Fullstack SSR architecture, tech stack, project structure, Banner/Footer branding, **UI shell & spacing** (flex main, sticky footer, services page padding pattern), rendering strategy, client vs server components, routing, data flow, styling. |

---

## Features

| Document | Description |
|----------|-------------|
| [features/platform-features.md](features/platform-features.md) | Features: public site, layout shell, `/documentation` + `/docs`, blog, courses, services, help, contact, SEO, admin, components (incl. SiteLogo). |
| [features/ported-components.md](features/ported-components.md) | Components ported from Codevensiva: RichContent, RoutableTabs, ArticleTocSidebar, documentation/help pages. Source → target mapping, adaptations, and dependencies. |

---

## Setup & Deployment

| Document | Description |
|----------|-------------|
| [setup/environment-and-deployment-guide.html](setup/environment-and-deployment-guide.html) | **Start here to go live.** Neon (`DATABASE_URL`), NextAuth & admin seed env vars (with screenshot), Vercel (New Project, Add Domain, Domains list + DNS records, registrar/Namecheap nameservers), Edge middleware / Hobby size note, go-live checklist, Neon reference, local Docker optional, Prisma, NPM scripts, troubleshooting (incl. `_middleware` too large). |
| [setup/database-and-prisma-guide.html](setup/database-and-prisma-guide.html) | PostgreSQL schema (User, Post, Course, Contact), Prisma ORM, API route patterns, server component queries, seed script. |
| [setup/authentication-guide.html](setup/authentication-guide.html) | NextAuth.js v5, `auth.config.ts` (Edge) + `auth.ts` (Prisma/Credentials), slim middleware for Vercel, JWT sessions, admin layout, login page, auth flow. |

---

## Guidelines & Standards

| Document | Description |
|----------|-------------|
| [docs-html-style-guide.md](docs-html-style-guide.md) | HTML documentation style guide: dark theme, sidebar + main layout, CSS classes, head/body templates. |

---

## Archive

| Document | Description |
|----------|-------------|
| [archive/vite-to-nextjs-migration.md](archive/vite-to-nextjs-migration.md) | Complete record of the Vite → Next.js migration: files deleted, files created, components modified, build errors fixed. |

---

## Adding New Documentation

When adding new docs:
1. **Prefer `.html`** with the dark theme layout (see `docs-html-style-guide.md`). Use `.md` only when referenced from code.
2. **Add an entry** to `docs/documentation-index.json`.
3. **Add a row** to this README in the appropriate section.
