|
| 1 | +# Missing Documentation Pages |
| 2 | + |
| 3 | +This document lists all documentation pages that are referenced in the docs but do not yet exist. These links are currently broken and need content to be created. |
| 4 | + |
| 5 | +## SDK Architecture Pages |
| 6 | + |
| 7 | +The following `/sdk/arch/` pages are referenced but don't exist: |
| 8 | + |
| 9 | +### 1. `/sdk/arch/sdk-package` |
| 10 | +**Referenced in:** |
| 11 | +- `sdk/guides/custom-tools.mdx` (line ~30): "SDK Package Architecture - Tool System" section |
| 12 | +- `sdk/guides/custom-tools.mdx` (line ~310): "Next Steps" section |
| 13 | + |
| 14 | +**Expected content:** Deep dive into the SDK package structure including: |
| 15 | +- Tool system architecture and design principles |
| 16 | +- Typed capabilities |
| 17 | +- Other SDK components |
| 18 | + |
| 19 | +### 2. `/sdk/arch/tools-package` |
| 20 | +**Referenced in:** |
| 21 | +- `sdk/guides/custom-tools.mdx` (line ~20): Introduction section |
| 22 | +- `sdk/guides/custom-tools.mdx` (line ~310): "Next Steps" section |
| 23 | +- `sdk/guides/hello-world.mdx` (line ~69): Tools explanation |
| 24 | + |
| 25 | +**Expected content:** Built-in tools design philosophy and complete list of available tools |
| 26 | + |
| 27 | +### 3. `/sdk/arch/agent-server-package` |
| 28 | +**Referenced in:** |
| 29 | +- `sdk/guides/agent-server/overview.mdx` (line ~154): "For architectural details" section |
| 30 | + |
| 31 | +**Expected content:** Remote execution architecture and deployment details |
| 32 | + |
| 33 | +### 4. `/sdk/arch/workspace-package` |
| 34 | +**Referenced in:** |
| 35 | +- `sdk/guides/agent-server/overview.mdx` (line ~155): "For architectural details" section |
| 36 | +- `sdk/getting-started.mdx` (line ~52): "Explore Documentation" section |
| 37 | + |
| 38 | +**Expected content:** Execution environments and isolation architecture |
| 39 | + |
| 40 | +### 5. `/sdk/arch/sdk/overview` |
| 41 | +**Referenced in:** |
| 42 | +- `sdk/getting-started.mdx` (line ~50): "Explore Documentation" section |
| 43 | + |
| 44 | +**Expected content:** Deep dive into SDK components |
| 45 | + |
| 46 | +### 6. `/sdk/arch/tools/overview` |
| 47 | +**Referenced in:** |
| 48 | +- `sdk/getting-started.mdx` (line ~51): "Explore Documentation" section |
| 49 | + |
| 50 | +**Expected content:** Overview of available tools |
| 51 | + |
| 52 | +### 7. `/sdk/arch/overview` |
| 53 | +**Referenced in:** |
| 54 | +- `sdk/index.mdx` (line ~75): "Core Concepts" card |
| 55 | + |
| 56 | +**Expected content:** General architecture overview covering agents, tools, workspaces, and more |
| 57 | + |
| 58 | +## API Reference Pages |
| 59 | + |
| 60 | +The following API reference pages are referenced but may not exist in the expected format: |
| 61 | + |
| 62 | +### 1. `/sdk/guides/agent-server/api-reference/vscode/get-vscode-url` |
| 63 | +**Referenced in:** |
| 64 | +- `sdk/guides/agent-server/api-sandbox.mdx` (line ~97) |
| 65 | +- `sdk/guides/agent-server/docker-sandbox.mdx` (line ~82) |
| 66 | + |
| 67 | +**Status:** The OpenAPI spec at `openapi/agent-sdk.json` contains the `/vscode/url` endpoint, but the generated API reference path structure may not match the expected format. |
| 68 | + |
| 69 | +### 2. `/sdk/guides/agent-server/api-reference/desktop/get-desktop-url` |
| 70 | +**Referenced in:** |
| 71 | +- `sdk/guides/agent-server/api-sandbox.mdx` (line ~98) |
| 72 | +- `sdk/guides/agent-server/docker-sandbox.mdx` (line ~83) |
| 73 | + |
| 74 | +**Status:** The OpenAPI spec at `openapi/agent-sdk.json` contains the `/desktop/url` endpoint, but the generated API reference path structure may not match the expected format. |
| 75 | + |
| 76 | +## Other Missing Pages |
| 77 | + |
| 78 | +### 1. `/sdk/llms/configuration` |
| 79 | +**Referenced in:** |
| 80 | +- `openhands/usage/llms/llms.mdx` |
| 81 | + |
| 82 | +**Expected content:** SDK-specific LLM configuration guide |
| 83 | + |
| 84 | +### 2. `/sdk/guides/github-workflows/routine-maintenance` |
| 85 | +**Referenced in:** |
| 86 | +- `sdk/index.mdx` (line ~104): "GitHub Workflows" card |
| 87 | + |
| 88 | +**Expected content:** Guide for using agents in GitHub workflows for routine maintenance tasks |
| 89 | + |
| 90 | +## Summary |
| 91 | + |
| 92 | +**Total missing pages:** 7 architecture pages + 2 API reference path issues + 2 guide pages |
| 93 | + |
| 94 | +**Priority:** |
| 95 | +1. High: Core architecture pages (`/sdk/arch/overview`, `/sdk/arch/tools-package`, `/sdk/arch/sdk-package`) |
| 96 | +2. Medium: Package-specific architecture (`/sdk/arch/agent-server-package`, `/sdk/arch/workspace-package`) |
| 97 | +3. Medium: Fix API reference path generation or update links to match actual generated paths |
| 98 | +4. Medium: Guide pages (`/sdk/llms/configuration`, `/sdk/guides/github-workflows/routine-maintenance`) |
| 99 | +5. Low: Alternative overview pages (`/sdk/arch/sdk/overview`, `/sdk/arch/tools/overview`) |
| 100 | + |
| 101 | +**Note:** Path fixes made in this PR: |
| 102 | +- `docker-sandboxed-server` → `docker-sandbox` |
| 103 | +- `local-agent-server` → `local-server` |
| 104 | +- `api-sandboxed-server` → `api-sandbox` |
| 105 | +- `remote-agent-server/local-agent-server` → `agent-server/local-server` |
0 commit comments