Skip to content

docs: sync llms.txt with Sphinx toctrees #349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
K1rL3s merged 2 commits into from
Sep 20, 2026
Merged

docs: sync llms.txt with Sphinx toctrees #349

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81c99c7
docs: keep llms.txt in sync with Sphinx toctrees
Sep 16, 2026
76986dc
docs: убрал тест на llms.txt и уточнил описания страниц
K1rL3s Sep 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions docs/_extra/llms.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@

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

- [Начало работы](https://maxo.readthedocs.io/ru/latest/pages/getting-started.html): Установка через uv/poetry/pip, требования, быстрый старт - эхо-бот, команды, клавиатуры, вебхук.
- [Начало работы](https://maxo.readthedocs.io/ru/latest/pages/getting-started.html): Установка через uv/poetry/pip, дополнительные зависимости, быстрый старт - эхо-бот, команды, клавиатуры.
- [Обработка событий - обзор](https://maxo.readthedocs.io/ru/latest/pages/event-handling/index.html): Архитектура цепочки обработки апдейтов в maxo.
- [Роутеры](https://maxo.readthedocs.io/ru/latest/pages/event-handling/routers.html): Структура бота через `Dispatcher` и `Router`, вложенность, масштабирование.
- [Фильтры](https://maxo.readthedocs.io/ru/latest/pages/event-handling/filters.html): Встроенные фильтры (`Command`, `CommandStart`), кастомные фильтры, комбинирование, интеграция с `magic_filter`.
- [Мидлвари](https://maxo.readthedocs.io/ru/latest/pages/event-handling/middlewares.html): Outer/Inner middleware, поток выполнения, типичные сценарии.
- [Хендлеры](https://maxo.readthedocs.io/ru/latest/pages/event-handling/handlers.html): Сигнатуры функций-обработчиков, контекст `Ctx`, внедрение зависимостей.
- [Флаги](https://maxo.readthedocs.io/ru/latest/pages/event-handling/flags.html): Метаданные хендлеров: установка декоратором, при регистрации и фильтрами, чтение из мидлварей.
- [FSM](https://maxo.readthedocs.io/ru/latest/pages/event-handling/fsm.html): Машина состояний, `StatesGroup`, `MemoryStorage`, `RedisStorage`.
- [Фасады](https://maxo.readthedocs.io/ru/latest/pages/event-handling/facades.html): Объекты-обёртки над API для упрощённой работы с апдейтами.
- [Ошибки](https://maxo.readthedocs.io/ru/latest/pages/event-handling/errors.html): Перехват исключений и обработка ошибок.
Expand All @@ -32,12 +33,24 @@
- [Тестирование диалогов](https://maxo.readthedocs.io/ru/latest/pages/dialogs/testing.html): Тесты в памяти через `BotClient` и `MockMessageManager` без реального API.
- [Превью диалогов](https://maxo.readthedocs.io/ru/latest/pages/dialogs/preview.html): HTML-превью окон и PNG-диаграмма переходов.

## Утилиты

- [Link Utility](https://maxo.readthedocs.io/ru/latest/pages/utils/link.html): Сборка ссылок `max://` и `https://max.ru`, перевод ID сообщения в ссылку и обратно.
- [Авто-ответ на колбэк](https://maxo.readthedocs.io/ru/latest/pages/utils/callback_answer.html): `CallbackAnswerMiddleware` отвечает на `MessageCallback` после нажатия инлайн-кнопки.
- [Действия бота в чате](https://maxo.readthedocs.io/ru/latest/pages/utils/chat_action.html): `ChatActionSender` и `ChatActionMiddleware` для повторной отправки действий в чате.

## API Reference

- [Bot API](https://maxo.readthedocs.io/ru/latest/pages/botapi/index.html): Полная API-справка по типам, методам, апдейтам и енумам, сгенерированная из официальной документации MAX.
- [Bot](https://maxo.readthedocs.io/ru/latest/pages/botapi/bot.html): Класс `Bot`: запросы к API и параметры сессии.
- [Types](https://maxo.readthedocs.io/ru/latest/pages/botapi/types.html): Модели данных API (сообщения, пользователи, чаты и др.).
- [Methods](https://maxo.readthedocs.io/ru/latest/pages/botapi/methods.html): Методы платформы: отправка текста и медиа, клавиатуры.
- [Omitted](https://maxo.readthedocs.io/ru/latest/pages/botapi/omitted.html): Различие «не передано» и `None` через sentinel `Omitted` и guard-функции.
- [Enums](https://maxo.readthedocs.io/ru/latest/pages/botapi/enums.html): Перечисления и константы для типизации параметров и событий.
- [Updates](https://maxo.readthedocs.io/ru/latest/pages/botapi/updates.html): Модели апдейтов (`MessageCreated`, `MessageCallback` и др.).
- [Форматирование текста](https://maxo.readthedocs.io/ru/latest/pages/botapi/text_formatting.html): HTML/Markdown и программное построение текста через `maxo.utils.formatting`.
- [Полезные заметки](https://maxo.readthedocs.io/ru/latest/pages/useful_notes.html): Особенности поведения MAX Bot API.
- [Changelog](https://maxo.readthedocs.io/ru/latest/pages/changelog.html): История релизов, собираемая из GitHub Releases.

## Optional

Expand All @@ -48,4 +61,4 @@
- [DeepWiki](https://deepwiki.com/K1rL3s/maxo): Автогенерированный гайд по коду.
- [Telegram-чат @maxo_py](https://t.me/maxo_py): Поддержка и обсуждение.
- [Платформа для партнёров MAX](https://business.max.ru/self): Получение токена бота.
- [Bot API MAX (официальная документация)](https://dev.max.ru/docs-api): Базовый API мессенджера.
- [Bot API MAX (официальная документация)](https://dev.max.ru/docs-api): Базовый API мессенджера.
Loading