Skip to content

Commit 81c9b74

Browse files
Merge remote-tracking branch 'origin/main' into tmp1
2 parents 76c9b98 + aabf093 commit 81c9b74

25 files changed

Lines changed: 110 additions & 57111 deletions

‎.github/workflows/check-llms-files.yml‎

Lines changed: 0 additions & 61 deletions
This file was deleted.

‎AGENTS.md‎

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -42,26 +42,29 @@ Documentation should describe these boundaries accurately. If a documentation PR
4242

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

45-
Mintlify auto-generates `/llms.txt` and `/llms-full.txt`, but this repo **overrides** them by committing
46-
`llms.txt` and `llms-full.txt` at the repo root.
47-
48-
We do this so LLMs get **V1-only** context while legacy V0 pages remain available for humans.
49-
50-
- Generator script: `scripts/generate-llms-files.py`
51-
- Sync workflow: `.github/workflows/check-llms-files.yml` runs weekly (and on demand) to open a PR when the files drift.
52-
- Regenerate (recommended):
53-
```bash
54-
make llms
55-
```
56-
Or directly:
57-
```bash
58-
python3 scripts/generate-llms-files.py
59-
```
60-
- Local verify (optional):
61-
```bash
62-
make llms-check
63-
```
64-
- Exclusions: `openhands/usage/v0/` and any `V0*`-prefixed page files.
45+
Mintlify generates and hosts `/llms.txt` and `/llms-full.txt` on deployment.
46+
Do not commit custom files at those paths: they override Mintlify's generated files.
47+
48+
The indexing policy lives in the repository:
49+
50+
- `docs.json` explicitly sets `seo.indexing` to `"navigable"`. Keep this setting;
51+
`"all"` opts hidden and noindex pages back into the generated LLM files.
52+
- Legacy pages under `openhands/usage/v0/`, `V0*`-prefixed page files, and the former
53+
monorepo `openhands/usage/architecture/backend.mdx` and `runtime.mdx` use
54+
`noindex: true` in their frontmatter. Add it to any new legacy pages too.
55+
- `noindex` preserves page URLs and navigation entries, but excludes pages from
56+
both LLM files, site search, sitemaps, search engines, and AI assistant context.
57+
- Pages outside navigation are omitted automatically. Add current documentation
58+
to `docs.json` when it should be included; the old generator scanned all MDX files.
59+
- Do not use `.mintignore` for legacy pages that must remain accessible to readers.
60+
61+
See [Mintlify's llms.txt documentation](https://www.mintlify.com/docs/ai/llmstxt)
62+
and [indexing controls](https://www.mintlify.com/docs/organize/hidden-pages#search-seo-and-ai-indexing).
63+
64+
After deployment, check `/llms.txt` and `/llms-full.txt` for current SDK, Agent Canvas,
65+
Cloud, and CLI pages, and confirm legacy page entries are absent. Links to legacy
66+
pages inside current page bodies can still appear; these settings filter page
67+
entries, not every mention of V0.
6568

6669
## Local development
6770

‎Makefile‎

Lines changed: 0 additions & 12 deletions
This file was deleted.

‎README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,20 @@ mint dev
2727

2828
The documentation site is automatically deployed via Mintlify when changes are pushed to the main branch.
2929

30+
## LLM Context Files
31+
32+
Mintlify generates [`llms.txt`](https://docs.openhands.dev/llms.txt) and
33+
[`llms-full.txt`](https://docs.openhands.dev/llms-full.txt) when the site deploys.
34+
There are no checked-in overrides or regeneration jobs.
35+
36+
`docs.json` sets `seo.indexing` to `"navigable"`. Legacy V0 and former monorepo
37+
architecture pages have `noindex: true` in their MDX frontmatter, so they stay
38+
accessible to readers but are excluded from the generated LLM files, search,
39+
sitemaps, and AI assistant context. Pages outside navigation are also omitted.
40+
When adding legacy documentation, include `noindex: true`; when adding current
41+
documentation, include it in the navigation. See `AGENTS.md` for the full policy
42+
and [Mintlify's documentation](https://www.mintlify.com/docs/ai/llmstxt).
43+
3044
## Repository boundaries
3145

3246
This site documents a multi-repository OpenHands system. [`OpenHands/OpenHands`](https://github.com/OpenHands/OpenHands) owns Agent Canvas, [`OpenHands/software-agent-sdk`](https://github.com/OpenHands/software-agent-sdk) owns the Python SDK and Agent Server, [`OpenHands/typescript-client`](https://github.com/OpenHands/typescript-client) owns the browser client for the Agent Server API, [`OpenHands/automation`](https://github.com/OpenHands/automation) owns scheduling and dispatch, and [`OpenHands/extensions`](https://github.com/OpenHands/extensions) owns reusable skills, plugins, automations, and integrations.

‎docs.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
"$schema": "https://mintlify.com/docs.json",
33
"theme": "mint",
44
"name": "OpenHands Docs",
5+
"seo": {
6+
"indexing": "navigable"
7+
},
58
"colors": {
69
"primary": "#99873c",
710
"light": "#ffe165",
@@ -386,6 +389,7 @@
386389
"sdk/guides/agent-acp",
387390
"sdk/guides/agent-interactive-terminal",
388391
"sdk/guides/agent-browser-use",
392+
"sdk/guides/browser-session-recording",
389393
"sdk/guides/agent-custom",
390394
"sdk/guides/agent-file-based",
391395
"sdk/guides/agent-stuck-detector",
@@ -413,6 +417,7 @@
413417
"sdk/guides/agent-server/overview",
414418
"sdk/guides/agent-server/orchestration-clients",
415419
"sdk/guides/agent-server/local-server",
420+
"sdk/arch/agent-server",
416421
"sdk/guides/agent-server/conversation-goals",
417422
"sdk/guides/agent-server/docker-sandbox",
418423
"sdk/guides/agent-server/apptainer-sandbox",

0 commit comments

Comments
 (0)