Lumie Documentation
Purpose
This site is Lumie's product documentation hub. It describes how the Lumie system is built, operated, and extended across the frontend, backend, workers, infrastructure, data model, and developer workflow.
English pages under docusaurus/docs/** are the source of truth. Korean pages
are localized mirrors and should follow the same structure after the English
source page changes.
How To Read The Docs
| Section | Use it when you need to understand |
|---|---|
| Architecture | System shape, runtime boundaries, and technology choices |
| Backend | Spring Boot modular monolith, modules, tenancy, messaging, and domain services |
| Frontend | Next.js application structure, routing, state, and testing |
| Workers | FastAPI background services for grading, reports, analysis, and chatbot work |
| Data Model | PostgreSQL schema families, RLS, billing tables, ERDs, and migrations |
| Infrastructure | K3s, GitOps, networking, platform services, and cluster foundations |
| Operations | Day-two operations for applications, storage, observability, and security |
| Development | Workspace layout, Tilt workflow, documentation rules, and shared workflow control plane |
Troubleshooting pages are intentionally separate from reference docs. Use them for incident-specific runbooks rather than as the canonical description of a service or architecture.
Source-Of-Truth Rules
- Write or update the English page first.
- Anchor technical claims to real code, configuration, migrations, manifests, or deployed behavior.
- Keep Docusaurus structure in
sidebars.js,_category_.json, and page frontmatter. - Mirror completed English pages into Korean only after the source page is stable.
- Do not use localized pages as the upstream source for new documentation.
Common Starting Points
- New to the repository layout: start with Workspace.
- Changing a backend module: start with Backend Overview.
- Changing worker behavior: start with Workers Overview.
- Changing a table or migration: start with Data Model Overview.
- Changing cluster configuration: start with Infrastructure Overview.
Verification
For structural or link-heavy documentation changes, build the site:
cd lumie-document/docusaurus
npm run build
Docusaurus is currently configured to report broken links as warnings in some paths. Treat those warnings as work items even when the build exits successfully.