こしあんスクエア Docs

このリポジトリは、こしあんスクエアの設計情報を Docs as Code で管理する場所です。

方針

DB       -> DBML
API      -> OpenAPI
Frontend -> Markdown / YAML
Docs     -> MkDocs Material
Hosting  -> GitHub Pages

管理対象

領域	形式	主要な置き場
DB設計	DBML / Markdown	`schema/`, `docs/db/`
API仕様	OpenAPI	`openapi/`, `docs/api/`
画面設計	Markdown / YAML	`docs/screens/`
画面遷移	Mermaid	`docs/flows/`
アーキテクチャ	Markdown	`docs/architecture/`

全体像

flowchart TD
  Supabase[Supabase migration] --> DBML[DBML]
  DBML --> MkDocs[MkDocs]
  FastAPI[FastAPI] --> OpenAPI[openapi.json]
  OpenAPI --> MkDocs
  Frontend[Next.js screen specs] --> MkDocs
  Figma[Figma / Storybook] --> Frontend
  MkDocs --> Pages[GitHub Pages]