Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,10 @@ Workflow: `.github/workflows/sync-agent-sdk-openapi.yml`
- When linking internally, prefer **absolute** doc paths (e.g. `/overview/quickstart`).
- Cloud integration docs live under `openhands/usage/cloud/`, and pages surfaced in **Documentation → Integrations → Cloud API** must also be added to the `Cloud API` group in `docs.json`.

### Mintlify tab ownership

When the same page path appears under multiple top-level tabs in `docs.json`, Mintlify resolves the page to one tab/sidebar (effectively the first matching tab). If you want a page to show a distinct left navigation for a new tab, that page should live **exclusively** under that tab rather than being duplicated across tabs.

### SDK guide file naming

SDK guide files under `sdk/guides/` use a **category prefix** to group related pages:
Expand Down
93 changes: 49 additions & 44 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,37 +67,9 @@
"pages": [
"openhands/usage/settings/application-settings",
"openhands/usage/settings/llm-settings",
"openhands/usage/settings/integrations-settings",
"openhands/usage/settings/secrets-settings",
"openhands/usage/settings/api-keys-settings",
"openhands/usage/settings/mcp-settings"
]
},
{
"group": "OpenHands Cloud",
"pages": [
"openhands/usage/cloud/openhands-cloud",
"openhands/usage/cloud/cloud-ui"
]
}
]
},
{
"group": "Integrations",
"pages": [
"openhands/usage/settings/integrations-settings",
"openhands/usage/cloud/github-installation",
"openhands/usage/cloud/gitlab-installation",
"openhands/usage/cloud/bitbucket-installation",
"openhands/usage/cloud/slack-installation",
"openhands/usage/cloud/project-management/jira-integration",
{
"group": "Cloud API",
"pages": [
"openhands/usage/cloud/cloud-api",
"openhands/usage/cloud/plugin-launcher",
"openhands/usage/api/v1"
]
}
]
},
Expand Down Expand Up @@ -403,32 +375,65 @@
]
},
{
"tab": "Enterprise",
"tab": "Cloud",
"pages": [
"enterprise/index",
"enterprise/enterprise-vs-oss",
"enterprise/quick-start",
{
"group": "K8s Install",
"group": "OpenHands Cloud",
"pages": [
"enterprise/k8s-install/index",
"enterprise/k8s-install/resource-limits"
"openhands/usage/cloud/openhands-cloud",
"openhands/usage/cloud/cloud-ui"
]
},
{
"group": "Product Guides",
"group": "Settings",
"pages": [
"openhands/usage/settings/integrations-settings",
"openhands/usage/settings/api-keys-settings"
]
},
{
"group": "Integrations",
"pages": [
"openhands/usage/settings/integrations-settings",
"openhands/usage/cloud/github-installation",
"openhands/usage/cloud/gitlab-installation",
"openhands/usage/cloud/bitbucket-installation",
"openhands/usage/cloud/slack-installation",
"openhands/usage/cloud/project-management/jira-integration",
{
"group": "Automations (BETA)",
"icon": "clock",
"group": "Cloud API",
"pages": [
"openhands/usage/automations/overview",
"openhands/usage/automations/creating-automations",
"openhands/usage/automations/managing-automations",
"openhands/usage/automations/examples"
"openhands/usage/cloud/cloud-api",
"openhands/usage/cloud/plugin-launcher",
"openhands/usage/api/v1"
]
}
]
},
{
"group": "Automations (BETA)",
"icon": "clock",
"pages": [
"openhands/usage/automations/overview",
"openhands/usage/automations/creating-automations",
"openhands/usage/automations/managing-automations",
"openhands/usage/automations/examples"
]
}
]
},
{
"tab": "Enterprise",
"pages": [
"enterprise/index",
"enterprise/enterprise-vs-oss",
"enterprise/quick-start",
{
"group": "K8s Install",
"pages": [
"enterprise/k8s-install/index",
"enterprise/k8s-install/resource-limits"
]
}
]
}
Expand Down Expand Up @@ -463,7 +468,7 @@
"href": "https://openhands.dev/blog"
},
{
"label": "OpenHands Cloud",
"label": "Cloud",
"href": "https://app.all-hands.dev"
},
{
Expand Down Expand Up @@ -700,4 +705,4 @@
"destination": "/openhands/usage/v0/runtimes/V0_daytona"
}
]
}
}
Loading