Add docs
This commit is contained in:
32
docs/.vitepress/config.mts
Normal file
32
docs/.vitepress/config.mts
Normal file
@ -0,0 +1,32 @@
|
||||
import { defineConfig } from "vitepress"
|
||||
|
||||
export default defineConfig({
|
||||
title: "CMS Docs",
|
||||
description: "Engineering documentation for the CMS platform",
|
||||
cleanUrls: true,
|
||||
lastUpdated: true,
|
||||
themeConfig: {
|
||||
nav: [
|
||||
{ text: "Home", link: "/" },
|
||||
{ text: "Getting Started", link: "/getting-started" },
|
||||
{ text: "Architecture", link: "/architecture" },
|
||||
{ text: "Workflow", link: "/workflow" },
|
||||
],
|
||||
sidebar: [
|
||||
{
|
||||
text: "Guide",
|
||||
items: [
|
||||
{ text: "Overview", link: "/" },
|
||||
{ text: "Getting Started", link: "/getting-started" },
|
||||
{ text: "Architecture", link: "/architecture" },
|
||||
{ text: "Workflow", link: "/workflow" },
|
||||
],
|
||||
},
|
||||
],
|
||||
socialLinks: [{ icon: "github", link: "https://example.com/replace-with-repo" }],
|
||||
footer: {
|
||||
message: "Internal documentation",
|
||||
copyright: "Copyright © CMS",
|
||||
},
|
||||
},
|
||||
})
|
||||
20
docs/architecture.md
Normal file
20
docs/architecture.md
Normal file
@ -0,0 +1,20 @@
|
||||
# Architecture
|
||||
|
||||
## Monorepo Structure
|
||||
|
||||
- `apps/web`: public app
|
||||
- `apps/admin`: admin app
|
||||
- `packages/db`: prisma + data access
|
||||
- `packages/content`: shared schemas and domain contracts
|
||||
- `packages/ui`: shared UI layer
|
||||
- `packages/config`: shared TS config
|
||||
|
||||
## Design Principles
|
||||
|
||||
- Shared contracts before feature implementation
|
||||
- RBAC and CRUD base as prerequisites for MVP1 feature work
|
||||
- Keep admin and public responsibilities clearly separated
|
||||
|
||||
## Pending Documentation
|
||||
|
||||
See documentation tasks in `TODO.md` under the Documentation track.
|
||||
38
docs/getting-started.md
Normal file
38
docs/getting-started.md
Normal file
@ -0,0 +1,38 @@
|
||||
# Getting Started
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
bun install
|
||||
```
|
||||
|
||||
## Environment
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
## Database
|
||||
|
||||
```bash
|
||||
bun run db:generate
|
||||
bun run db:migrate
|
||||
bun run db:seed
|
||||
```
|
||||
|
||||
## Run apps
|
||||
|
||||
```bash
|
||||
bun run dev
|
||||
```
|
||||
|
||||
- Web: `http://localhost:3000`
|
||||
- Admin: `http://localhost:3001`
|
||||
|
||||
## Run docs
|
||||
|
||||
```bash
|
||||
bun run docs:dev
|
||||
```
|
||||
|
||||
- Docs: `http://localhost:4173`
|
||||
20
docs/index.md
Normal file
20
docs/index.md
Normal file
@ -0,0 +1,20 @@
|
||||
# CMS Docs
|
||||
|
||||
Engineering documentation hub for this repository.
|
||||
|
||||
## Core Sources
|
||||
|
||||
- Roadmap and progress: `TODO.md`
|
||||
- Branching and promotion flow: `BRANCHING.md`
|
||||
- Contribution and commit schema: `CONTRIBUTING.md`
|
||||
- Release history: `CHANGELOG.md`
|
||||
|
||||
## Documentation Scope
|
||||
|
||||
This docs site should track:
|
||||
|
||||
- Architecture and domain boundaries
|
||||
- RBAC and permission model
|
||||
- CRUD standards and implementation patterns
|
||||
- Delivery pipeline and environment promotion flow
|
||||
- Operational runbooks (deploy, rollback, incident response)
|
||||
30
docs/workflow.md
Normal file
30
docs/workflow.md
Normal file
@ -0,0 +1,30 @@
|
||||
# Workflow
|
||||
|
||||
## Branching Model
|
||||
|
||||
Follow `BRANCHING.md`:
|
||||
|
||||
- Long-lived: `main`, `staging`, `dev`
|
||||
- Task branches: `todo/*`, `refactor/*`, `code/*`
|
||||
|
||||
## Promotion Path
|
||||
|
||||
1. Task branch -> `dev`
|
||||
2. `dev` -> `staging`
|
||||
3. `staging` -> `main`
|
||||
|
||||
## Quality Gates
|
||||
|
||||
- `bun run lint`
|
||||
- `bun run typecheck`
|
||||
- `bun run test`
|
||||
- `bun run test:e2e --list`
|
||||
|
||||
## Changelog
|
||||
|
||||
- Conventional commits required (see `CONTRIBUTING.md`)
|
||||
- Generate changelog with:
|
||||
|
||||
```bash
|
||||
bun run changelog:release
|
||||
```
|
||||
Reference in New Issue
Block a user