Repository navigation
Use Mintlify-generated LLM context - #815
Conversation
|
Follow-up audit of the 16 pages outside navigation, by an AI agent on Astra helping Engel Nyst (@enyst). We should not add all 16 to navigation. But treating all 16 as expendable would also be a mistake. There is current material worth preserving, particularly browser recording and Agent Server setup. Some pages are already linked from current documentation despite having no sidebar entry. I compared the pages with the rest of the docs at Page-by-page recommendationPaths below are relative to the docs root. “Retire” means preserve historical access or redirect after checking inbound links, not delete URLs indiscriminately.
Source verification
Cloud limitation: I could not access the Cloud implementation through the available clone/integration paths. Accordingly, the three Cloud rows above are documentation-consistency findings and publication recommendations, not claims that Jira DC or Linear are unsupported. The Enterprise Jira page is a better scoped document in the corpus, not independently verified backend behavior in this audit. Implication for this PRI would keep the Mintlify migration, but resolve preservation of current content before merging: browser recording, Agent Server operations, and the current Canvas environment settings should have a navigable home. MCP merits a corrected architecture entry. The other cleanup can be scoped separately, with explicit legacy labeling or redirects and inbound-link updates. A regular body link to an unlisted page does not put it into |
|
Opened the two follow-ups as enyst:
The follow-ups are linked using GitHub's new native stack feature (stack #818): #816 is layer 1/2 and #817 is layer 2/2, each with only its own diff. There is one GitHub limitation: cross-fork stacks are not supported. This PR's head is in enyst/docs, so #815 cannot be included in the native stack itself. To preserve this PR and its discussion, I created Merge order remains #815 → #816 → #817. Both follow-ups are drafts: after #815 merges, rebase the follow-up commits onto main and retarget the native stack before merging them. If #815 changes before merging, the stack base and follow-up branches will need updating too. Source evidence and validation details are in both PR descriptions. Both GitHub link-check workflows have passed. |
# Conflicts: # llms-full.txt # llms.txt
all-hands-bot
left a comment
There was a problem hiding this comment.
Reviewed and verified the core migration against source and Mintlify's own docs. Looks good to merge.
Verified:
- Mintlify's llms.txt/indexing docs confirm the mechanism this PR relies on:
noindex: trueexcludes pages fromllms.txt/llms-full.txtas well as site search, sitemaps, and AI context, andseo.indexingdefaults to"navigable"(valid enum:navigable|all). The explicit"navigable"setting is the correct, documented default. - All 10 V0 pages under
openhands/usage/v0/and both former monorepo architecture pages carry booleannoindex: true; noV0*-prefixed pages exist outside that directory. docs.jsonadds exactly the two intended navigation entries (sdk/arch/agent-server,sdk/guides/browser-session-recording), removes no entries or redirects, and all 288 page entries resolve to existing files. Both new nav targets exist, and the new internal links/anchors resolve.- The
browser-session-recordingexample matches upstream SDK example 38 byte-for-byte;BROWSER_RECORDING_OUTPUT_DIR(.agent_tmp/browser_observations) and the sixOH_CONVERSATION_*variables matchsoftware-agent-sdkanddev-safe.mjs. Themake buildinsync-agent-sdk-openapi.ymltargets the agent-sdk submodule, so removing the root Makefile is safe; no stale references to the generator remain.
Non-blocking notes:
- This is a real behavior change beyond LLM context: pages without navigation drop out of the generated index (the old generator scanned every MDX file), and
noindexalso removes the legacy pages from search engines/sitemaps. The follow-ups (#816 MCP, #817 consolidation/redirects) restore the remaining current material, so the #815 → #816 → #817 order matters. - Worth confirming after deploy that
/llms.txtand/llms-full.txtcontain the current SDK/Agent Canvas/Cloud/CLI entries and omit the 12 excluded pages.
This review was posted by an AI agent (OpenHands) on behalf of the requester.
Why
We maintain two generated LLM context files to keep legacy V0 documentation out of agent context. Mintlify now supports that exclusion itself: its generated
llms.txtandllms-full.txtomit pages withnoindex: true, and deleting a custom file restores the generated version.Sources:
Changes
seo.indexing: "navigable"explicitly indocs.json.noindex: trueto all ten V0 MDX pages and the two former monorepo architecture pages already excluded by the generator.llms.txt,llms-full.txt, their generator, weekly sync workflow, generator-specific test, and the Makefile whose only targets regenerated those files.Legacy documentation remains readable at its existing URLs and in navigation. No documentation pages are removed or redirected.
Preserve current content
Behavior to account for
noindexalso excludes these pages from site search, sitemaps, external search indexing, and AI assistant context. It is not an LLM-only setting. Do not switchseo.indexingto"all", which opts excluded pages back into the generated LLM files..mintignoreis unsuitable here because it would unpublish the legacy pages.Mintlify follows navigation instead of scanning every MDX file. The audit identified 16 pages outside navigation. This update adds Agent Server and browser recording to navigation and preserves the current Canvas environment settings in an existing navigable page. The other unlisted pages remain accessible by URL but are omitted as standalone native LLM entries. See the audit comment for the follow-up recommendations.
The 16 pages identified by the original audit
openhands/usage/about.mdxopenhands/usage/agents.mdxopenhands/usage/cloud/project-management/jira-dc-integration.mdxopenhands/usage/cloud/project-management/linear-integration.mdxopenhands/usage/cloud/project-management/overview.mdxopenhands/usage/developers/debugging.mdxopenhands/usage/developers/development-overview.mdxopenhands/usage/developers/evaluation-harness.mdxopenhands/usage/developers/websocket-connection.mdxopenhands/usage/environment-variables.mdxopenhands/usage/llms/custom-llm-configs.mdxoverview/first-projects.mdxsdk/arch/agent-server.mdxsdk/arch/mcp.mdxsdk/arch/sdk.mdxsdk/guides/browser-session-recording.mdxThese controls exclude page entries; links or mentions of V0 inside current documentation can still appear in the full text.
Validation
noindex: truein parsed YAML frontmatter.headproperty rejection as upstream main; there are no new schema errors.git diff --checkpasses; no stale generator commands remain.mint validatewith CLI 4.2.909. It fails before building becauseos.networkInterfaces()returnsuv_interface_addresses: Unknown system error 1in this environment.Deployment verification remains necessary: fetch both generated files, check current SDK/Agent Canvas/Cloud/CLI page entries, and verify the 12 excluded pages are absent as entries. Also open a V0 page to confirm it remains accessible.
Prepared by an AI agent on Astra, helping Engel Nyst (@enyst) with project maintenance.