Local AI Toolkit

Пакеты документации

Оглавление · English version

lai localai docs build --root R:\YourRepo           # до 5 публичных C# типов
lai localai docs build --root R:\YourRepo --limit 20
lai localai docs build --root R:\YourRepo --all
lai localai docs build --root R:\YourRepo --standalone-html

Семантический индекс должен соответствовать исходникам: после изменения кода выполните lai localai sync --root R:\YourRepo. Единица документации — один публичный C# тип с точным определением в индексе, включая его члены и partial-объявления. Типы выбираются по пути файла и позиции в нём. Другие проиндексированные языки могут давать ссылки, но пока не становятся отдельными единицами документации. Подготовка читает и разбирает файлы-кандидаты до выбора нужного числа публичных типов, а также читает их partial-объявления и необходимые определения из индекса. Проверки актуальности Git и индекса по-прежнему охватывают worktree; --limit их не отключает.

Первый пилот выбирает буквальный путь файла или каталога относительно корня репозитория:

lai localai docs build --root R:\YourRepo --path src/YourLibrary --plan --json
lai localai docs build --root R:\YourRepo --path src/YourLibrary --all

--path учитывает регистр, принимает оба вида слеша и сопоставляет целые сегменты пути; шаблоны glob, абсолютные пути и .. не поддерживаются. Фильтр применяется до лимита в пять типов по умолчанию; изменить лимит можно через --limit или --all. Partial-объявления и необходимые определения зависимостей могут находиться вне выбранного пути. Пустая выборка возвращает scope_empty. Выбор по объявлению и изменениям относительно коммита не входит в этот пилот. --plan показывает ID выбранных объявлений, пути объявлений и зависимостей без вызова модели и создания пакета документации. JSON дополнительно содержит снимок репозитория и хеши исходников, ссылок и истории: выборку можно сверить с проиндексированными исходниками. Сборка выбранной области печатает план до генерации. Изменение определения зависимости сбрасывает кеш соответствующего текста; применение пакета сохраняет ручные правки и не затрагивает остальные единицы в целевом каталоге. Прежние команды и MCP-интерфейсы сохраняют поведение; пилот добавляет только параметры CLI.

Build пишет в каталог рантайма repositories/<repository-id>/documentation, вне worktree. Идентичность репозитория совпадает с используемой индексом: нормализованный общий каталог Git. Каждая единица содержит Markdown, HTML и PDF на EN/RU, диаграммы SVG/PNG и лицензии зависимостей. По умолчанию HTML-страницы используют один общий CSS в artifacts/_assets, названный по хешу содержимого. Оба шрифта встроены в CSS как data URL, без запросов к отдельным файлам шрифтов при локальном открытии. Одна копия обслуживает все единицы и сохранённые пакеты. docs apply копирует ресурс один раз в docs/generated/_assets, сохраняя относительные ссылки. Переносите этот каталог вместе со страницами. С --standalone-html шрифты, диаграмма и лицензии встраиваются в каждую HTML-страницу, которую можно переносить отдельно; ссылка на другой язык по-прежнему требует соседней страницы. Смена режима обновляет оформление проверенного текста без вызова модели. Перед применением проверяются хеши ресурсов; изменённый вручную CSS сохраняется и перечисляется в отчёте. Build восстанавливает отсутствующий или повреждённый CSS рантайма из встроенных ресурсов. Откройте index.en.html или index.ru.html в напечатанном каталоге пакета: там изменения и их причины, ошибки с указанием судьбы предыдущего документа, счётчик повторного использования и оглавление. Прочитайте текст и перевод, чтобы проверить смысл: автоматические проверки подтверждают ссылки и синтаксис.

Отдельно хешируются тела исходников, ссылки/связи индекса и связанные определения, последние десять сообщений коммитов по этим файлам. Неизменившаяся единица использует прежние байты без вызова модели. Проверенный двуязычный текст кешируется отдельно: изменение метки снимка или основной координаты типа обновляет оформление, а повреждённый готовый файл можно восстановить без повторной генерации. При ошибке сохраняется прежний проверенный документ, если он есть, а единица отмечается в отчёте. Завершённые единицы сохраняются после прерывания сборки. --json возвращает отчёт; проверяйте счётчик failed: успешно созданный отчёт может содержать ошибки отдельных единиц. Артефакты, оставленные после ошибки, несут прежнюю метку снимка и отмечаются в отчёте. Внутри записи репозитория история документации очищается только явной командой docs prune --apply. Сама запись всё же может уйти: когда localai prune удаляет брошенную запись репозитория или установщик удаляет индексы репозиториев, документация уходит вместе с ней.

lai localai docs pin --root R:\YourRepo --package <package-id>  # перед открытием пакета
lai localai docs prune --root R:\YourRepo --keep 5 --dry-run
lai localai docs prune --root R:\YourRepo --keep 5 --apply
lai localai docs unpin --root R:\YourRepo --package <package-id> # после закрытия

ID пакета — имя каталога из 32 символов, напечатанное build. Перед открытием закрепляйте пакет, после закрытия снимайте закрепление: произвольные вкладки браузера и внешние читатели автоматически не отслеживаются. Prune без --apply показывает план: размер каждого кандидата и причины сохранения/удаления. Выполнение пересчитывает план под общей блокировкой build, apply и pin. По умолчанию сохраняются пять последних по времени записи манифеста пакетов (минимум один), а также current, закреплённые и применённые версии. Сохраняются latest, две последние исправные версии каждого типа и используемые ими кеши текста и ресурсы. Защищённые версии могут превышать лимит --keep.

Apply записывает пакет-источник каждого управляемого файла, включая частичное применение и сохранённые ручные правки. При старых или неполных сведениях сохраняется вся история, пока успешный apply не согласует все старые записи. Незавершённый build также защищает историю до завершения сборки. Очистка отказывается работать с reparse points и повреждёнными метаданными защиты, не меняет worktree и сохраняет нераспознанные файлы. Удаляемые каталоги атомарно выводятся из действующей истории; остатки после сбоя удаляются следующим запуском. См. замеры и проверки очистки.

Ключ текста включает хеши исходников/ссылок/истории, факты и граф генератора, явные версии prompt, валидатора и маршрута. Идентичность маршрута также включает закреплённую последовательность моделей обзора и проверенный каталог маршрутизации, даже если его содержимое изменилось без смены catalogVersion. Версия рендерера и полные текущие реквизиты документа сбрасывают только готовые файлы. Изменение координат внутри цитируемых фактов по-прежнему сбрасывает текст. Старые кеши готовых файлов доступны для чтения и однократно пересобираются при следующем build. Правила смены версий, восстановление и границы замеров описаны в документации кеша.

Начните с поднабора по умолчанию и оцените измеренное время перед запуском --all. Генерация использует общий broker, его очередь/прогресс и установленную политику размещения. Build не скачивает модели и не ослабляет политику. Обзор создаёт gpt-oss:20b с одной попыткой исправления, затем используется qwen3.5:9b; перевод на русский идёт через настроенный маршрут PlainTranslation. Рендерер и измеренное сравнение моделей описаны в бенчмарке диаграмм.

После просмотра пакета:

lai localai docs apply --root R:\YourRepo

Apply копирует доступные документы в docs/generated/<symbol-hash>/, не вызывает модель и не создаёт коммит. Файлы с правками после предыдущего применения пропускаются, их пути печатаются; файлы от другого поднабора сохраняются. Если после build изменились исходники или HEAD, сначала повторите сборку. Символические ссылки и junction в каталоге назначения не допускаются. Просмотрите Git diff и закоммитьте принятые файлы вместе. Хук документации не устанавливается.


← Данные для анализа влияния: пилот C# · Оглавление · Собрать и проверить →