edx-lms¶

A statically generated, multi-tenant Learning Management System powered by Next.js 16, consuming content authored in apps/cms.

This page is the documentation entry point. It links to canonical topic pages instead of repeating implementation detail.

Documentation Structure¶

The docs use four document types. Keep the type clear so readers know whether they are looking at current behavior, implementation history, or proposed work.

When a shipped feature and future work appear in the same document, keep them in separate Currently implemented and Remaining work sections. Add future work to Roadmap instead of leaving TODOs only in a local reference page.

Root apps/lms/docs/ is the source of truth. The Zensical build (npm run docs:sync → docs:build → docs:publish) syncs these docs and the shared monorepo Cursor rules into docs/zensical/docs-source/ and emits a static site under public/docs/.

How It Works¶

The documentation pipeline has two sources of truth and one generated output:

1. Author-owned sources
   • LMS docs under apps/lms/docs/
   • Shared/root platform docs under docs/
   • Cursor rules under .cursor/rules/ and apps/lms/.cursor/rules/
2. Generated Zensical source
   • npm run docs:sync runs docs/zensical/scripts/sync_docs.py
   • The script mirrors docs into docs/zensical/docs-source/
   • The script also auto-generates the nav = [...] block in docs/zensical/zensical.toml between the auto-generated nav markers
3. Published static site
   • npm run docs:build renders HTML into docs/zensical/site/
   • npm run docs:publish copies the site into public/docs/ for the app to serve

This means new files (including platform audit tickets under docs/platform-auditing/tickets/) are picked up during sync, and navigation is regenerated automatically from the discovered source tree.

Published Project Rules¶

The Project Rules navigation publishes every shared rule from the repository .cursor/rules/ directory and every LMS-specific rule from apps/lms/.cursor/rules/. During docs:sync, the sync script strips Cursor frontmatter, rewrites rule links, converts each .mdc source to a .md page, and writes it under docs/zensical/docs-source/rules/. docs:publish copies the built pages into public/docs/, where they are available under /docs/rules/. Do not edit generated docs-source/rules/*.md files.

Canonical References¶

Use these pages as the source of truth for recurring topics:

Phase Summary¶

Milestone 1 status mirrors planning_milestone_1.md. Phases 4+ remain tracked in their milestone docs and roadmap.md.

Open items from these phases are tracked in Roadmap. Creator/marketplace feature proposals (F1–F15) also live in Milestone 4 and the roadmap.

Build Pipeline¶

Maintainers: project rules and reference markdown are authored under the repo root .cursor/rules/, apps/lms/.cursor/rules/, and apps/lms/docs/. From apps/lms, the pipeline is:

1. npm run docs:sync (or make -C docs/zensical sync-docs) — runs docs/zensical/scripts/sync_docs.py and writes only into docs/zensical/docs-source/ (Zensical input).
2. npm run docs:build — runs Zensical and writes static HTML into docs/zensical/site/.
3. npm run docs:publish — runs docs:build then copies docs/zensical/site/ to public/docs/ for Next.js (predev runs this so local dev serves fresh docs).