Документация LMS версия 0.1.0

Документация LMS

Коробочная платформа для онлайн-школы: одна установка — одна школа. Ставится на ваш сервер, данные лежат у вас, забрать их можно целиком и в любой момент.

Эта документация собрана на версию продукта 0.1.0, сборка из коммита 36e4758 от 7 августа 2026. У вашей установки может стоять другая версия — справочник вашей школы живёт на её собственном адресе, /docs.

С чего начать #

Кому Куда
Смотрю, подойдёт ли Что это за платформа и Чем отличается
Ставлю на сервер Установка
Работаю со школой Как пользоваться
Смотрю, что сможет API Проект API — реализации ещё нет
Меняю оформление Оформление
Подключаю ИИ-агента Для агентов

Что здесь уже есть, а чего ещё нет #

Документация пишется параллельно разработке, а не после неё. Поэтому часть страниц пока пустая, и это видно: у таких страниц наверху стоит пометка «раздел ещё не написан», а в перечне страниц они помечены отдельно.

Причина не в спешке. Документация, которую пишут по готовому продукту, описывает то, что получилось. Документация, которую пишут рядом, ловит места, где продукт неописуем, — и это самый дешёвый способ найти дыру в проектировании до того, как она станет кодом. Там, где страницу нельзя написать честно, вместо неё стоит объяснение, чего именно не хватает.

Что читается машиной #

Этот сайт сделан так, чтобы его читал не только человек. Ссылку можно отдать ИИ-агенту, и он разберётся сам.

  • /llms.txt — карта разделов, по одной строке на каждый. Точка входа для модели.
  • /llms-full.txt — вся документация одним текстом, чтобы не обходить страницы по одной.
  • /openapi.draft.json — спецификация API в машинном виде. «draft» в имени не для красоты: API ещё не написано, часть адресов предположительна. Адрес /openapi.json не занят намеренно.
  • Любая страница в Markdown — добавьте .md к её адресу: /api/errors.md.

Содержимое каждой страницы отдаётся готовым HTML: страница, пустая без JavaScript, для модели пустая. Подробнее — Машинные выходы.

Эта страница в Markdown