Platform recipe

GitHub Pages llms.txt recipe

For a GitHub Pages project, llms.txt should help AI assistants find the canonical project documentation instead of guessing from scattered repository files.

Best pages to include

• Project overview or README page.
• Installation, configuration, and examples.
• API documentation or command reference.
• Releases, changelog, license, and contribution guide.
• Security policy or support page for maintained projects.

Starter file

# Project Name

> Project Name helps developers [specific task].

## Summary

This GitHub Pages site publishes project documentation, setup instructions, examples, release notes, license information, and contribution guidance.

## Project Sources

- [Overview](https://example.github.io/project/): What the project does and when to use it.
- [Install](https://example.github.io/project/install/): Setup and configuration.
- [Examples](https://example.github.io/project/examples/): Working examples.
- [Releases](https://github.com/org/project/releases): Release notes and version history.

Link to the live documentation first, then repository pages where they are the source of truth.