Skip to main content

llms-txt/llms.txt

Source: examples/llms-txt/llms.txt

When To Use This Example​

Use this page as a concrete starting point when the file path and convention type match your project. Treat the content as a reference shape, not as a mandatory template.

How To Adapt It​

  • Keep fields that describe real project behavior.
  • Remove placeholders that do not apply to your repository.
  • Prefer short, explicit instructions over broad policy language.
  • Link the adapted file back to the convention it supports when possible.

Source File​

# Example Product Docs

> Documentation for a fictional SaaS product used to manage customers and subscriptions.

## Start Here

- [Getting started](https://example.com/docs/getting-started.md): Setup, first login, and workspace creation.
- [API overview](https://example.com/docs/api/overview.md): Authentication, pagination, errors, and rate limits.
- [Webhooks](https://example.com/docs/webhooks.md): Event payloads and retry behavior.

## Reference

- [REST API](https://example.com/docs/api/reference.md): Complete endpoint reference.
- [Changelog](https://example.com/docs/changelog.md): User-visible product and API changes.

## Optional

- [llms-full.txt](https://example.com/llms-full.txt): Expanded documentation bundle for offline ingestion.