Skip to content

Commit da03efc

Browse files
Merge main into dv/fix-docker-execution-env-vars
Co-authored-by: openhands <openhands@all-hands.dev>
2 parents 8e66acc + b4aab1b commit da03efc

43 files changed

Lines changed: 271 additions & 58001 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.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: 29 additions & 3 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",
@@ -412,6 +416,7 @@
412416
"pages": [
413417
"sdk/guides/agent-server/overview",
414418
"sdk/guides/agent-server/local-server",
419+
"sdk/arch/agent-server",
415420
"sdk/guides/agent-server/conversation-goals",
416421
"sdk/guides/agent-server/docker-sandbox",
417422
"sdk/guides/agent-server/apptainer-sandbox",
@@ -450,6 +455,7 @@
450455
"sdk/arch/agent",
451456
"sdk/arch/conversation",
452457
"sdk/arch/tool-system",
458+
"sdk/arch/mcp",
453459
"sdk/arch/events",
454460
"sdk/arch/workspace",
455461
"sdk/arch/llm",
@@ -731,11 +737,11 @@
731737
},
732738
{
733739
"source": "/openhands/usage/how-to/debugging",
734-
"destination": "/openhands/usage/developers/debugging"
740+
"destination": "/openhands/usage/agent-canvas/development"
735741
},
736742
{
737743
"source": "/openhands/usage/how-to/development-overview",
738-
"destination": "/openhands/usage/developers/development-overview"
744+
"destination": "/openhands/usage/agent-canvas/development"
739745
},
740746
{
741747
"source": "/openhands/usage/how-to/evaluation-harness",
@@ -799,7 +805,7 @@
799805
},
800806
{
801807
"source": "/openhands/usage/start-building",
802-
"destination": "/overview/first-projects"
808+
"destination": "/openhands/usage/get-started/tutorials"
803809
},
804810
{
805811
"source": "/overview/key-features",
@@ -920,6 +926,26 @@
920926
{
921927
"source": "/enterprise/custom-sandbox-image#run-multiple-custom-images-with-warm-runtime-pools",
922928
"destination": "/enterprise/custom-sandbox-images/multiple-images-warm-pools"
929+
},
930+
{
931+
"source": "/openhands/usage/about",
932+
"destination": "/overview/introduction"
933+
},
934+
{
935+
"source": "/openhands/usage/developers/debugging",
936+
"destination": "/openhands/usage/agent-canvas/development"
937+
},
938+
{
939+
"source": "/openhands/usage/developers/development-overview",
940+
"destination": "/openhands/usage/agent-canvas/development"
941+
},
942+
{
943+
"source": "/overview/first-projects",
944+
"destination": "/openhands/usage/get-started/tutorials"
945+
},
946+
{
947+
"source": "/sdk/arch/sdk",
948+
"destination": "/sdk/arch/overview"
923949
}
924950
]
925951
}

‎enterprise/conversations-and-sandboxes.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,9 +215,9 @@ PAT's permissions and the identity recorded in commits, see
215215
[Use a Service Account for Automated Conversations](/enterprise/integrations/github#use-a-service-account-for-automated-conversations).
216216

217217
For tested implementations, see the
218-
[per-conversation secrets](https://github.com/jpshackelford/oh-examples/tree/main/per-conversation-secrets)
218+
[per-conversation secrets](https://github.com/OpenHands/enterprise-cookbook/tree/main/per-conversation-secrets)
219219
and
220-
[service-account GitHub PAT](https://github.com/jpshackelford/oh-examples/tree/main/service-account-github-pat)
220+
[service-account GitHub PAT](https://github.com/OpenHands/enterprise-cookbook/tree/main/service-account-github-pat)
221221
examples.
222222

223223
### Select An Existing Sandbox

‎enterprise/integrations/external-llm-gateways.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -534,7 +534,7 @@ curl -X PATCH "$CONVERSATION_URL" \
534534
Export gateway spend logs filtered by time and model. Export the
535535
OpenHands conversation list filtered by tag. Join by timestamp and
536536
model. See the
537-
[conversation-tags example](https://github.com/jpshackelford/oh-examples/tree/main/conversation-tags)
537+
[conversation-tags example](https://github.com/OpenHands/enterprise-cookbook/tree/main/conversation-tags)
538538
for a working round-trip.
539539

540540
**What appears at the gateway.** Nothing. Tags live on the OpenHands

0 commit comments

Comments
 (0)