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

Секции и структура

Организация разделов в llms.txt

Рекомендуемые названия секций для документации:

СекцияНазначениеПриоритет
## DocsОсновная документацияВысокий
## APIAPI ReferenceВысокий
## GuidesРуководства и туториалыСредний
## ExamplesПримеры кодаСредний
## ReferenceСправочные материалыСредний
СекцияНазначениеПриоритет
## BlogСтатьи и новостиНизкий
## ChangelogИстория измененийНизкий
## CommunityСообщество, форумыНизкий
## OptionalВторостепенные ресурсыМожет быть пропущен

Секция ## Optional имеет специальное значение в спецификации. Ресурсы в ней могут быть пропущены при формировании контекста для LLM.

## Optional
- [Changelog](https://example.com/changelog): История версий
- [Roadmap](https://example.com/roadmap): Планы развития
- [Contributing](https://example.com/contributing): Как внести вклад
- [Code of Conduct](https://example.com/coc): Правила сообщества
- [License](https://example.com/license): Лицензия MIT
def get_context(llms_txt, include_optional=True):
sections = parse_llms_txt(llms_txt)
if not include_optional:
sections.pop('Optional', None)
return sections
  1. H1 заголовок — название проекта
  2. Blockquote — краткое описание
  3. Описательный текст — важные детали
  4. Основные секции — Docs, API, Guides
  5. Дополнительные секции — Examples, Reference
  6. Optional — всегда последняя
# FastHTML
> Modern Python web framework for building fast, interactive web applications.
Key features:
- No JavaScript required
- HTMX integration
- Server-side rendering
## Documentation
- [Getting Started](https://fastht.ml/docs/): Quick start guide
- [Tutorial](https://fastht.ml/docs/tutorial): Step-by-step tutorial
- [API Reference](https://fastht.ml/docs/api): Complete API docs
## Guides
- [Forms](https://fastht.ml/docs/guides/forms): Working with forms
- [Database](https://fastht.ml/docs/guides/db): Database integration
- [Deployment](https://fastht.ml/docs/guides/deploy): Production deployment
## Examples
- [Todo App](https://github.com/fasthtml/examples/todo): Basic todo application
- [Blog](https://github.com/fasthtml/examples/blog): Blog with comments
- [E-commerce](https://github.com/fasthtml/examples/shop): Shopping cart demo
## Optional
- [Changelog](https://fastht.ml/changelog): Version history
- [Contributing](https://github.com/fasthtml/fasthtml/CONTRIBUTING.md): Contribution guide
- [Discord](https://discord.gg/fasthtml): Community chat

Для сайтов с несколькими языками можно создавать отдельные файлы:

/llms.txt → Основной (английский)
/ru/llms.txt → Русская версия
/zh/llms.txt → Китайская версия
## Документация
- [Быстрый старт](https://example.com/ru/docs/start): Начните здесь
- [Справочник API](https://example.com/ru/docs/api): Описание API
## Tutorials
- [Beginner Tutorial](url): For new users (30 min)
- [Advanced Tutorial](url): Deep dive (2 hours)
- [Video Course](url): Video walkthrough
## API Reference
- [REST API](url): HTTP endpoints
- [GraphQL API](url): GraphQL schema
- [SDK Reference](url): Client libraries
## JavaScript
- [npm Package](url): Installation and usage
- [Browser Guide](url): Browser integration
## Python
- [PyPI Package](url): pip installation
- [Django Integration](url): Django setup

❌ Плохо:

## Getting Started
## Installation
## Configuration
## Basic Usage
## Advanced Usage
## Troubleshooting
## FAQ
## API
## REST
## GraphQL
## WebSocket
...

✅ Хорошо:

## Documentation
- [Getting Started](url): Includes installation, config, basic usage
- [Advanced Guide](url): Advanced topics and troubleshooting
## API Reference
- [Complete API](url): REST, GraphQL, WebSocket

Не создавайте секции без ссылок:

## Coming Soon
(пусто)

Одна ссылка должна быть только в одной секции.