llms.txt в MkDocs

Куда помещать файл

MkDocs собирает ваш docs_dir (по умолчанию docs/) в site/ папку. Файлы Markdown становятся HTML-страницами; все остальные файлы, включая .txt, копируется по соответствующему пути в site/. Поэтому docs/llms.txt доступен по адресу /llms.txt.

Рассматривайте файл как составную карту набора документации. Включите руководства по установке, справочники конфигурации, страницы API, заметки об обновлениях и журнал изменений, но не сваливайте в файл каждую автоматически созданную страницу. Небольшой поддерживаемый список легче проверять ассистентам и людям.

Метод: каталог docs/

1. Добавьте файл: touch docs/llms.txt
2. Составьте карту ключевых страниц документации (именно документация здесь нужна ассистентам):

# Your Project Docs

> Documentation for Your Project: installation, usage, and API reference.

## Guides

- [Installation](https://yourdomain.com/install/): setup and requirements.
- [User guide](https://yourdomain.com/guide/): day-to-day usage.

## Reference

- [API](https://yourdomain.com/api/): full reference.

3. Соберите и разверните: mkdocs build (или mkdocs gh-deploy для GitHub Pages).

Не включайте это в навигацию

Проверка настройки

curl -sI https://yourdomain.com/llms.txt | grep -i content-type
# expect: content-type: text/plain

Публикуете документацию через GitHub Pages? Учтите нюанс с базовым путём в Руководство по GitHub Pages. Создание содержимого файла описано в руководство; проверьте его с помощью валидатор.