Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/workflows/check-llms-files.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Verify llms context files

on:
pull_request:
workflow_dispatch:

jobs:
verify:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Regenerate llms.txt and llms-full.txt
run: python3 scripts/generate-llms-files.py

- name: Ensure committed llms files are up-to-date
run: git diff --exit-code llms.txt llms-full.txt
23 changes: 23 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,29 @@ The site is built with **Mintlify** and deployed automatically by Mintlify on pu
- `.agents/skills/` — prompt extensions for agents editing this repo (legacy: `.openhands/skills/`; formerly `microagents`)
- `tests/` — pytest checks for docs consistency (notably LLM pricing docs)


## llms.txt / llms-full.txt (V1-only)

Mintlify auto-generates `/llms.txt` and `/llms-full.txt`, but this repo **overrides** them by committing
`llms.txt` and `llms-full.txt` at the repo root.

We do this so LLMs get **V1-only** context while legacy V0 pages remain available for humans.

- Generator script: `scripts/generate-llms-files.py`
- Regenerate (recommended):
```bash
make llms
```
Or directly:
```bash
python3 scripts/generate-llms-files.py
```
- Verify they are up-to-date:
```bash
make llms-check
```
- Exclusions: `openhands/usage/v0/` and any `V0*`-prefixed page files.

## Local development

### Preview the site
Expand Down
12 changes: 12 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
.PHONY: llms llms-check

# Regenerate the Mintlify llms context files (V1-only override).
#
# See: scripts/generate-llms-files.py
llms:
python3 scripts/generate-llms-files.py

# Regenerate and fail if llms files changed (useful for local verification).
llms-check:
python3 scripts/generate-llms-files.py
git diff --exit-code llms.txt llms-full.txt
Loading
Loading