Description
To help language models (LLMs) better understand the structure of the website and navigate its main resources, we want to add an LLM.txt file at the root of the project.
This file will give a clear overview of the site, its key sections, and useful links for AI agents.
The website content already exists, but we need a way to keep the LLM.txt file up to date as the site evolves.
The goal is to automatically generate the file based on the current structure of the site (pages, sections, documentation, etc.), instead of maintaining it manually. This will ensure that language models (LLMs) always have an accurate and current description of the site.
It works similarly to robots.txt or humans.txt, but it is specifically meant for LLMs.
Goal
- Improve how AI models interpret the website.
- Provide a reliable entry point for AI‑based tools.
- Describe the main pages, their purpose, and the site structure.
- Create an LLM.txt file based on the existing website structure.
- Automate the generation process to keep the file updated.
- Provide LLM‑friendly information: key pages, descriptions, resources.
Expected Automation
The automated script or tool should:
- Scan the website (or the source code tree)
- Detect main pages and relevant sections
- Extract or generate short descriptions
- Produce a consistent
LLM.txt file
- Run automatically (CI/CD, build step, cron job…)
Example output format:
Site: [Site name]
Description: [Short 3–4 line description]
Generated on: <timestamp>
Main pages:
- /page1 : auto‑generated description
- /page2 : auto‑generated description
Resources:
- /docs : technical documentation
Notes for LLMs:
This file is automatically generated. Focus on structured pages.
Deliverables
- Automated script or tool for generating
LLM.txt
- Configuration for automatic execution (CI/CD pipeline or scheduled job)
- Generated
LLM.txt file stored at the project root
- Documentation explaining how to run or update the generator
Tasks
Description
To help language models (LLMs) better understand the structure of the website and navigate its main resources, we want to add an
LLM.txtfile at the root of the project.This file will give a clear overview of the site, its key sections, and useful links for AI agents.
The website content already exists, but we need a way to keep the LLM.txt file up to date as the site evolves.
The goal is to automatically generate the file based on the current structure of the site (pages, sections, documentation, etc.), instead of maintaining it manually. This will ensure that language models (LLMs) always have an accurate and current description of the site.
It works similarly to
robots.txtorhumans.txt, but it is specifically meant for LLMs.Goal
Expected Automation
The automated script or tool should:
LLM.txtfileExample output format:
Deliverables
LLM.txtLLM.txtfile stored at the project rootTasks
LLM.txtfrom the site content