Перейти к основному содержимому

База знаний (интерфейс)

Что это​

«База знаний» — это раздел интерфейса raytsystem (маршрут /handbook, группа «Пространство»), который показывает эту документацию прямо внутри приложения, без перехода на отдельный сайт. Слева — список разделов и статей со статусами, справа — выбранная статья.

Когда использовать​

Когда нужно свериться с документацией, не покидая контрол-плейн: например, посмотреть, что делает раздел «Вселенная», как построить граф кода или какие функции отключены по умолчанию.

Что означают элементы​

  • Поиск статьи — фильтрует список по названию.
  • Разделы — те же разделы, что и в полной базе знаний (Начало работы, Интерфейс, Граф проекта и т.д.).
  • Статус-метка у статьи (стабильно, эксперимент, отключено, черновик, генерируется) повторяет status из статьи.
  • Ссылки внутри статьи переключают статью в этом же разделе.

Ограничения и безопасность​

  • Раздел только для чтения: он не меняет никакое состояние и не отправляет данные наружу.
  • Backend-эндпоинты GET /api/v1/handbook и GET /api/v1/handbook/article читают файлы документации из фиксированного каталога website/docs с защитой от выхода за пределы каталога и без перехода по симлинкам (src/raytsystem/webapp/handbook.py).
  • Содержимое статей очищается от служебного синтаксиса (frontmatter, MDX-импорты, admonition-блоки) и отображается компактным безопасным рендерером, который не вставляет произвольный HTML.
  • Если каталог website/docs отсутствует рядом с установкой, раздел честно показывает, что база знаний недоступна.

Связанные страницы​

Источники истины​

  • src/raytsystem/webapp/handbook.py
  • web/src/features/Handbook.tsx