Skip to content

DRAFT - Work in Process - Restructure docs navigation #271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jpelletier1 wants to merge 5 commits into from
Closed

DRAFT - Work in Process - Restructure docs navigation #271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
97e78ad
feat: Restructure docs navigation to align with Devin.ai
openhands-agent Jan 22, 2026
f4c3e25
fix: Update navigation structure based on feedback
openhands-agent Jan 22, 2026
1290bd5
fix: Remove SDK redirect causing infinite loop
openhands-agent Jan 22, 2026
7fd371d
docs: Add detailed gap analysis comparing Devin documentation
openhands-agent Jan 22, 2026
d2a19de
Restructure docs navigation and add gap analysis pages
openhands-agent Jan 22, 2026
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
518 changes: 518 additions & 0 deletions docs-navigation-proposal.md
View file
Open in desktop

Large diffs are not rendered by default.

230 changes: 135 additions & 95 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,108 +20,112 @@
"navigation": {
"tabs": [
{
"tab": "Overview",
"tab": "Getting Started",
"pages": [
{
"group": "Overview",
"group": "Getting Started",
"pages": [
"overview/introduction",
"overview/quickstart",
"overview/your-first-session",
"overview/first-projects",
"overview/faqs",
"overview/community",
"overview/contributing"
]
},
{
"group": "Common Features",
"pages": [
"overview/model-context-protocol",
{
"group": "Skills",
"pages": [
"overview/skills",
"overview/skills/repo",
"overview/skills/keyword",
"overview/skills/org",
"overview/skills/public"
]
}
"overview/faqs"
]
},
{
"group": "Tips and Tricks",
"group": "Best Practices",
"pages": [
"openhands/usage/tips/prompting-best-practices"
"openhands/usage/tips/prompting-best-practices",
"openhands/usage/tips/when-to-use-openhands",
"openhands/usage/tips/effective-instructions",
"openhands/usage/tips/good-vs-bad-instructions",
"openhands/usage/tips/limitations"
]
},
{
"group": "Help",
"group": "Community",
"pages": [
"openhands/usage/troubleshooting/troubleshooting",
"openhands/usage/troubleshooting/feedback"
"overview/community",
"overview/contributing"
]
}
]
},
{
"tab": "Web",
"tab": "Documentation",
"pages": [
{
"group": "Key Features",
"group": "Setup & Installation",
"pages": [
"openhands/usage/key-features"
"openhands/usage/cli/installation",
"openhands/usage/run-openhands/local-setup",
"openhands/usage/advanced/configuration-options"
]
},
{
"group": "OpenHands Cloud",
"group": "Running OpenHands",
"pages": [
"openhands/usage/cloud/openhands-cloud",
{
"group": "Integrations",
"group": "Terminal (TUI)",
"pages": [
"openhands/usage/cloud/bitbucket-installation",
"openhands/usage/cloud/github-installation",
"openhands/usage/cloud/gitlab-installation",
"openhands/usage/cloud/slack-installation",
{
"group": "Project Management Tools",
"pages": [
"openhands/usage/cloud/project-management/jira-integration"
]
}
"openhands/usage/cli/terminal",
"openhands/usage/cli/web-interface",
"openhands/usage/cloud/openhands-cloud"
]
},
"openhands/usage/cloud/cloud-ui",
"openhands/usage/cloud/cloud-api"
"openhands/usage/cli/local-gui",
"openhands/usage/cli/headless",
{
"group": "IDE Integration (ACP)",
"pages": [
"openhands/usage/cli/ide/overview",
"openhands/usage/cli/ide/vscode",
"openhands/usage/cli/ide/jetbrains",
"openhands/usage/cli/ide/zed",
"openhands/usage/cli/ide/toad"
]
}
]
},
{
"group": "Local GUI",
"group": "Integrations",
"pages": [
"openhands/usage/run-openhands/local-setup",
"openhands/usage/run-openhands/gui-mode"
"openhands/usage/integrations/overview",
"openhands/usage/cli/mcp-servers"
]
},
{
"group": "REST API",
"openapi": "openapi/openapi.json"
},
{
"group": "Customizations & Settings",
"group": "Features & Configuration",
"pages": [
"openhands/usage/key-features",
"openhands/usage/workspace-tools",
"openhands/usage/sdlc-integration",
"openhands/usage/repo-setup",
"openhands/usage/playbooks",
{
"group": "OpenHands Settings",
"group": "Skills",
"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"
"overview/skills",
"overview/skills/repo",
"overview/skills/keyword",
"overview/skills/org",
"overview/skills/public"
]
},
"openhands/usage/customization/repository"
"overview/model-context-protocol",
"openhands/usage/customization/repository",
"openhands/usage/cli/critic"
]
},
{
"group": "Settings",
"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"
]
},
{
Expand Down Expand Up @@ -170,61 +174,97 @@
}
]
},
"openhands/usage/advanced/configuration-options",
"openhands/usage/advanced/custom-sandbox-guide",
"openhands/usage/advanced/search-engine-setup"
]
},
{
"group": "Reference",
"pages": [
"openhands/usage/cli/command-reference",
"openhands/usage/cli/resume"
]
},
{
"group": "Help",
"pages": [
"openhands/usage/troubleshooting/troubleshooting",
"openhands/usage/troubleshooting/feedback"
]
}
]
},
{
"tab": "CLI",
"tab": "Use Cases",
"pages": [
{
"group": "Getting Started",
"group": "Overview",
"pages": [
"openhands/usage/cli/installation",
"openhands/usage/cli/quick-start"
"use-cases/overview",
"use-cases/best-practices"
]
},
{
"group": "Ways to Run",
"group": "Use Cases",
"pages": [
"openhands/usage/cli/terminal",
"openhands/usage/cli/headless",
"openhands/usage/cli/web-interface",
"openhands/usage/cli/gui-server",
{
"group": "IDE Integration (ACP)",
"pages": [
"openhands/usage/cli/ide/overview",
"openhands/usage/cli/ide/zed",
"openhands/usage/cli/ide/toad",
"openhands/usage/cli/ide/vscode",
"openhands/usage/cli/ide/jetbrains"
]
}
"use-cases/examples/code-migrations",
"use-cases/examples/test-coverage",
"use-cases/examples/bug-fixing",
"use-cases/examples/documentation",
"use-cases/examples/refactoring",
"use-cases/examples/api-integration"
]
},
{
"group": "Cloud",
"group": "Tutorials",
"pages": [
"openhands/usage/cli/cloud"
"use-cases/tutorials/getting-started",
"use-cases/tutorials/rest-api",
"use-cases/tutorials/test-coverage",
"use-cases/tutorials/containerization",
"use-cases/tutorials/frontend-development"
]
},
{
"group": "Extensions",
"group": "Prompt Library",
"pages": [
"openhands/usage/cli/mcp-servers",
"openhands/usage/cli/critic"
"use-cases/prompts/testing-refactoring",
"use-cases/prompts/data-analysis",
"use-cases/prompts/web-development"
]
}
]
},
{
"tab": "OpenHands Cloud",
"pages": [
{
"group": "Getting Started",
"pages": [
"openhands/usage/cloud/cloud-ui",
"openhands/usage/cloud/cloud-api",
"openhands/usage/cli/cloud"
]
},
{
"group": "Reference",
"group": "Integrations",
"pages": [
"openhands/usage/cli/command-reference",
"openhands/usage/cli/resume"
"openhands/usage/cloud/github-installation",
"openhands/usage/cloud/gitlab-installation",
"openhands/usage/cloud/bitbucket-installation",
"openhands/usage/cloud/slack-installation",
{
"group": "Project Management",
"pages": [
"openhands/usage/cloud/project-management/jira-integration",
"openhands/usage/cloud/project-management/linear-integration"
]
}
]
},
{
"group": "REST API",
"openapi": "openapi/openapi.json"
}
]
},
Expand Down Expand Up @@ -305,9 +345,9 @@
{
"group": "GitHub Workflows",
"pages": [
"sdk/guides/github-workflows/assign-reviews",
"sdk/guides/github-workflows/pr-review",
"sdk/guides/github-workflows/todo-management"
"sdk/guides/github-workflows/todo-management",
"sdk/guides/github-workflows/assign-reviews"
]
}
]
Expand Down Expand Up @@ -411,6 +451,10 @@
"source": "/usage/:slug*",
"destination": "/openhands/usage/:slug*"
},
{
"source": "/openhands/usage/cli/gui-server",
"destination": "/openhands/usage/cli/local-gui"
},
{
"source": "/openhands/usage/configuration-options",
"destination": "/openhands/usage/advanced/configuration-options"
Expand Down Expand Up @@ -459,10 +503,6 @@
"source": "/openhands/usage/prompting/microagents-public",
"destination": "/openhands/usage/microagents/microagents-public"
},
{
"source": "/openhands/usage/prompting/microagents-repo",
"destination": "/openhands/usage/microagents/microagents-repo"
},
{
"source": "/openhands/usage/installation",
"destination": "/openhands/usage/quick-start"
Expand Down Expand Up @@ -580,4 +620,4 @@
"destination": "/openhands/usage/cli/resume"
}
]
}
}
2 changes: 1 addition & 1 deletion openhands/usage/cli/gui-server.mdx → openhands/usage/cli/local-gui.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: GUI Server
title: Local GUI
description: Launch the full OpenHands web GUI using Docker
---

Expand Down
2 changes: 1 addition & 1 deletion openhands/usage/cli/quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The OpenHands CLI provides multiple ways to interact with the OpenHands AI agent
| [Terminal (TUI)](/openhands/usage/cli/terminal) | `openhands` | Interactive development |
| [Headless](/openhands/usage/cli/headless) | `openhands --headless` | Scripts & automation |
| [Web Interface](/openhands/usage/cli/web-interface) | `openhands web` | Browser-based TUI |
| [GUI Server](/openhands/usage/cli/gui-server) | `openhands serve` | Full web GUI |
| [Local GUI](/openhands/usage/cli/local-gui) | `openhands serve` | Full web GUI |
| [IDE Integration](/openhands/usage/cli/ide/overview) | `openhands acp` | Zed, VS Code, JetBrains |

<iframe
Expand Down
4 changes: 2 additions & 2 deletions openhands/usage/cli/web-interface.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Run the web interface on a shared server for team access:
openhands web --host 0.0.0.0 --port 8080
```

## Comparison: Web Interface vs GUI Server
## Comparison: Web Interface vs Local GUI

| Feature | `openhands web` | `openhands serve` |
|---------|-----------------|-------------------|
Expand All @@ -105,5 +105,5 @@ openhands web --host 0.0.0.0 --port 8080
## See Also

- [Terminal Mode](/openhands/usage/cli/terminal) - Direct terminal usage
- [GUI Server](/openhands/usage/cli/gui-server) - Full web GUI with Docker
- [Local GUI](/openhands/usage/cli/local-gui) - Full web GUI with Docker
- [Command Reference](/openhands/usage/cli/command-reference) - All CLI options
Loading
Loading