docs: consolidate obsolete pages and label retained legacy references - #817
Conversation
c66b0e7 to
80401c5
Compare
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
80401c5 to
7dca05f
Compare
all-hands-bot
left a comment
There was a problem hiding this comment.
Approved. Rebased onto main and the stack is unwound: #888 has landed #816’s content on main, so this branch’s own copy of the same MCP commit is now upstream and the rebase dropped it together with the two duplicate docs/mintlify-native-llms-stack-base commits. The branch is now a single commit directly on main (16 files, +109/−797), and the PR is ready for review (no longer draft).
The one conflict was docs.json: main’s new enterprise/custom-sandbox-image redirects landed at the same insertion point as this PR’s five new redirects. Both sets were kept — no entries were dropped.
What I verified on the rebased result:
- All five removed pages (
openhands/usage/about,openhands/usage/developers/debugging,openhands/usage/developers/development-overview,overview/first-projects,sdk/arch/sdk) are gone from the tree and from navigation, and each has a direct redirect to an existing destination (/overview/introduction,/openhands/usage/agent-canvas/development,/openhands/usage/get-started/tutorials,/sdk/arch/overview). - Redirect sources are unique across all 60 entries (no duplicates introduced by the merge).
- Every internal link and anchor added by the diff resolves, including
/openhands/usage/agent-canvas/development#docker-conversation-runtime-settings(the heading exists),/openhands/usage/agent-canvas/architecture,/openhands/usage/agent-canvas/llm-profiles,/sdk/guides/llm-profile-store, and/sdk/arch/agent-server. - The five retained legacy pages all carry boolean
noindex: trueand archive<Warning>notices; the First Projects prompts moved into the navigable Tutorial Library; thesdk/arch/llmtable now points at the SDK LLM profile store. - Cited sources check out:
Conversation.send_messageupdates state and returnsNone, and the CanvasDEVELOPMENT.md,dev-safe.mjs, and benchmarks README/runner references resolve. docs.jsonparses,git diff --checkis clean, and the branch isMERGEABLEagainstmain. Mintlify preview/deploy, link-rot, and internal-link checks pass.
Note: this PR is still part of GitHub’s native stack (stack #818, position 2/2). Since its base is now main and the earlier layer is merged, the stack should collapse on merge; nothing else to retarget. The remaining blocker is just the required review.
This review was posted by an AI agent (OpenHands) on behalf of the reviewer.
Follow-up to the orphan-page audit in #815. The two base PRs (#815 and #888) are merged, so this branch has been rebased directly onto
mainand the stack dependency is resolved.Five superseded pages are removed with redirects: the old About page, debugging guide, development overview, First Projects, and SDK overview. Beginner prompts move into the navigable Tutorial Library. Current inbound links and older redirect aliases now point directly to their replacements.
Five references remain accessible with legacy/archive notices and
noindex: true: CodeAct agents, the old evaluation harness, Socket.IO protocol, named TOML LLM configs, and the mixed environment-variable reference. Current Canvas runtime settings remain in Canvas Development, as preserved by #815. The SDK LLM architecture page now points to the SDK profile store. The three unverified “Coming soon” Cloud integration pages are left intact.This intentionally does not present Canvas architecture as a full replacement wire-protocol guide, or benchmark runners as a generic harness-authoring guide.
Rebase note
#888 (the #816 stack base) landed #816’s MCP content on
main. This branch carried its own copy of the same MCP commit, which is now upstream, so rebasing dropped it along with the duplicatedocs/mintlify-native-llms-stack-basecommits. The only conflict wasdocs.json, where main’s newenterprise/custom-sandbox-imageredirects sat at the same insertion point as this PR’s new redirects; both sets were kept. The net diff is now the 16 files below, applied directly on top ofmain, with no leftover stack dependency.Source verification:
add_message()example.Validation: all five deleted URLs have direct redirects to existing pages; redirect sources are unique (60 entries, no duplicates); removed pages are absent from navigation; added internal links and anchors resolve, including
#docker-conversation-runtime-settings; retained legacy pages have booleannoindex; changed YAML/JSON parse;git diff --checkpasses; the rebased branch is mergeable againstmain.Description updated by an AI agent (OpenHands) on behalf of the author.