FML HUB

Documentation Hub

Choose your documentation dashboard

This docs hub is split by audience. Use the User Dashboard for learning and classroom usage, and the Developer Dashboard for architecture, implementation, and operations.

Dashboard Routes

Audience: students and teachers

User Documentation Dashboard

Covers onboarding, learning flow, chapter usage, AI assist workflow, revision strategy, and troubleshooting for day-to-day learning.

Go to user dashboard

Audience: maintainers and contributors

Developer Documentation Dashboard

Covers repository architecture, local setup, tool integration, testing, deployment policy, and secure key handling for production.

Go to developer dashboard

Root Markdown Docs

Deep-dive docs now live in root docs/ so the repo has a stable written reference alongside the dashboard pages.

User docs in root

  • docs/user/USER-DOCUMENTATION.md
  • docs/user/LEARNING-WORKFLOWS.md
  • docs/user/TROUBLESHOOTING.md

Developer docs in root

  • docs/developer/DEVELOPER-DOCUMENTATION.md
  • docs/developer/ARCHITECTURE-DEEP-DIVE.md
  • docs/developer/OPERATIONS-RUNBOOK.md

Documentation Standards

  • Audience-first structure with separate user and developer tracks.
  • Stable command examples and path references for reproducible setup.
  • Security-first guidance with no private keys committed to source control.
  • Branch-aware release notes matching main and official-deployment.

References