Skip to content

docs: migrate contributing guide to docs repo and update navigation #18

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
wants to merge 9 commits into from
Closed

docs: migrate contributing guide to docs repo and update navigation #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6ca3a4e
docs: add contributing page under developers and update docs.json for…
jamiechicago312 Oct 10, 2025
f2368a6
Update openhands/usage/developers/contributing.mdx
enyst Oct 11, 2025
73990b7
docs: add Development Guide page and link it in nav; update Contribut…
enyst Oct 11, 2025
0336e9e
Update openhands/usage/developers/development-overview.mdx
enyst Oct 12, 2025
bc1d067
Update openhands/usage/developers/contributing.mdx
enyst Oct 12, 2025
6b18f1f
fix(docs): valid YAML front matter in contributing.mdx to restore Min…
enyst Oct 12, 2025
0f3b0c6
docs(contributing): update frontmatter description text per request\n…
enyst Oct 12, 2025
c23d510
docs: reorder OpenHands Developers nav (Contributing first) and remov…
enyst Oct 12, 2025
f71ca50
Merge branch 'main' into migrate-contributing-doc
enyst Oct 13, 2025
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
224 changes: 148 additions & 76 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,52 +65,52 @@
{
"group": "Advanced Configuration",
"pages": [
{
"group": "LLM Configuration",
"pages": [
"openhands/usage/llms/llms",
{
"group": "Providers",
"pages": [
"openhands/usage/llms/openhands-llms",
"openhands/usage/llms/azure-llms",
"openhands/usage/llms/google-llms",
"openhands/usage/llms/groq",
"openhands/usage/llms/local-llms",
"openhands/usage/llms/litellm-proxy",
"openhands/usage/llms/moonshot",
"openhands/usage/llms/openai-llms",
"openhands/usage/llms/openrouter"
]
}
]
},
{
"group": "Runtime Configuration",
"pages": [
"openhands/usage/runtimes/overview",
{
"group": "Providers",
"pages": [
"openhands/usage/runtimes/docker",
"openhands/usage/runtimes/remote",
"openhands/usage/runtimes/local",
{
"group": "Third-Party Providers",
"pages": [
"openhands/usage/runtimes/modal",
"openhands/usage/runtimes/daytona",
"openhands/usage/runtimes/runloop",
"openhands/usage/runtimes/e2b"
]
}
]
}
]
},
"openhands/usage/advanced/configuration-options",
"openhands/usage/advanced/custom-sandbox-guide",
"openhands/usage/advanced/search-engine-setup"
{
"group": "LLM Configuration",
"pages": [
"openhands/usage/llms/llms",
{
"group": "Providers",
"pages": [
"openhands/usage/llms/openhands-llms",
"openhands/usage/llms/azure-llms",
"openhands/usage/llms/google-llms",
"openhands/usage/llms/groq",
"openhands/usage/llms/local-llms",
"openhands/usage/llms/litellm-proxy",
"openhands/usage/llms/moonshot",
"openhands/usage/llms/openai-llms",
"openhands/usage/llms/openrouter"
]
}
]
},
{
"group": "Runtime Configuration",
"pages": [
"openhands/usage/runtimes/overview",
{
"group": "Providers",
"pages": [
"openhands/usage/runtimes/docker",
"openhands/usage/runtimes/remote",
"openhands/usage/runtimes/local",
{
"group": "Third-Party Providers",
"pages": [
"openhands/usage/runtimes/modal",
"openhands/usage/runtimes/daytona",
"openhands/usage/runtimes/runloop",
"openhands/usage/runtimes/e2b"
]
}
]
}
]
},
"openhands/usage/advanced/configuration-options",
"openhands/usage/advanced/custom-sandbox-guide",
"openhands/usage/advanced/search-engine-setup"
]
}
]
Expand Down Expand Up @@ -156,8 +156,9 @@
{
"group": "OpenHands Developers",
"pages": [
"openhands/usage/developers/contributing",
"openhands/usage/developers/development-overview",
"openhands/usage/contributing",
"openhands/usage/developers/development-guide",
{
"group": "Architecture",
"pages": [
Expand Down Expand Up @@ -185,8 +186,8 @@
]
},
{
"tab": "API Reference",
"openapi": "openapi/openapi.json"
"tab": "API Reference",
"openapi": "openapi/openapi.json"
}
],
"global": {
Expand Down Expand Up @@ -214,8 +215,7 @@
"dark": "/logo/dark.png"
},
"navbar": {
"links": [
],
"links": [],
"primary": {
"type": "github",
"href": "https://github.com/All-Hands-AI/OpenHands"
Expand All @@ -236,29 +236,101 @@
]
},
"redirects": [
{ "source": "/modules/:slug*", "destination": "/:slug*"},
{ "source": "/usage/:slug*", "destination": "/openhands/usage/:slug*"},
{ "source": "/openhands/usage/configuration-options", "destination": "/openhands/usage/advanced/configuration-options" },
{ "source": "/openhands/usage/how-to/custom-sandbox-guide", "destination": "/openhands/usage/advanced/custom-sandbox-guide" },
{ "source": "/openhands/usage/search-engine-setup", "destination": "/openhands/usage/advanced/search-engine-setup" },
{ "source": "/openhands/usage/prompting/repository", "destination": "/openhands/usage/customization/repository" },
{ "source": "/openhands/usage/how-to/debugging", "destination": "/openhands/usage/developers/debugging" },
{ "source": "/openhands/usage/how-to/development-overview", "destination": "/openhands/usage/developers/development-overview" },
{ "source": "/openhands/usage/how-to/evaluation-harness", "destination": "/openhands/usage/developers/evaluation-harness" },
{ "source": "/openhands/usage/how-to/websocket-connection", "destination": "/openhands/usage/developers/websocket-connection" },
{ "source": "/openhands/usage/prompting/microagents-keyword", "destination": "/openhands/usage/microagents/microagents-keyword" },
{ "source": "/openhands/usage/prompting/microagents-org", "destination": "/openhands/usage/microagents/microagents-org" },
{ "source": "/openhands/usage/prompting/microagents-overview", "destination": "/openhands/usage/microagents/microagents-overview" },
{ "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" },
{ "source": "/openhands/usage/how-to/cli-mode", "destination": "/openhands/usage/run-openhands/cli-mode" },
{ "source": "/openhands/usage/how-to/github-action", "destination": "/openhands/usage/run-openhands/github-action" },
{ "source": "/openhands/usage/how-to/gui-mode", "destination": "/openhands/usage/run-openhands/gui-mode" },
{ "source": "/openhands/usage/how-to/headless-mode", "destination": "/openhands/usage/run-openhands/headless-mode" },
{ "source": "/openhands/usage/local-setup", "destination": "/openhands/usage/run-openhands/local-setup" },
{ "source": "/openhands/usage/getting-started", "destination": "/openhands/usage/start-building" },
{ "source": "/openhands/usage/prompting/prompting-best-practices", "destination": "/openhands/usage/tips/prompting-best-practices" },
{ "source": "/openhands/usage/feedback", "destination": "/openhands/usage/troubleshooting/feedback" }
{
"source": "/modules/:slug*",
"destination": "/:slug*"
},
{
"source": "/usage/:slug*",
"destination": "/openhands/usage/:slug*"
},
{
"source": "/openhands/usage/configuration-options",
"destination": "/openhands/usage/advanced/configuration-options"
},
{
"source": "/openhands/usage/how-to/custom-sandbox-guide",
"destination": "/openhands/usage/advanced/custom-sandbox-guide"
},
{
"source": "/openhands/usage/search-engine-setup",
"destination": "/openhands/usage/advanced/search-engine-setup"
},
{
"source": "/openhands/usage/prompting/repository",
"destination": "/openhands/usage/customization/repository"
},
{
"source": "/openhands/usage/how-to/debugging",
"destination": "/openhands/usage/developers/debugging"
},
{
"source": "/openhands/usage/how-to/development-overview",
"destination": "/openhands/usage/developers/development-overview"
},
{
"source": "/openhands/usage/how-to/evaluation-harness",
"destination": "/openhands/usage/developers/evaluation-harness"
},
{
"source": "/openhands/usage/how-to/websocket-connection",
"destination": "/openhands/usage/developers/websocket-connection"
},
{
"source": "/openhands/usage/prompting/microagents-keyword",
"destination": "/openhands/usage/microagents/microagents-keyword"
},
{
"source": "/openhands/usage/prompting/microagents-org",
"destination": "/openhands/usage/microagents/microagents-org"
},
{
"source": "/openhands/usage/prompting/microagents-overview",
"destination": "/openhands/usage/microagents/microagents-overview"
},
{
"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"
},
{
"source": "/openhands/usage/how-to/cli-mode",
"destination": "/openhands/usage/run-openhands/cli-mode"
},
{
"source": "/openhands/usage/how-to/github-action",
"destination": "/openhands/usage/run-openhands/github-action"
},
{
"source": "/openhands/usage/how-to/gui-mode",
"destination": "/openhands/usage/run-openhands/gui-mode"
},
{
"source": "/openhands/usage/how-to/headless-mode",
"destination": "/openhands/usage/run-openhands/headless-mode"
},
{
"source": "/openhands/usage/local-setup",
"destination": "/openhands/usage/run-openhands/local-setup"
},
{
"source": "/openhands/usage/getting-started",
"destination": "/openhands/usage/start-building"
},
{
"source": "/openhands/usage/prompting/prompting-best-practices",
"destination": "/openhands/usage/tips/prompting-best-practices"
},
{
"source": "/openhands/usage/feedback",
"destination": "/openhands/usage/troubleshooting/feedback"
}
]
}
}
2 changes: 1 addition & 1 deletion openhands/usage/advanced/custom-sandbox-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ docker run -it --rm --pull=always \

### Setup

First, ensure you can run OpenHands by following the instructions in [Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md).
First, ensure you can run OpenHands by following the instructions in our [Development Guide](/openhands/usage/developers/development-guide).

### Specify the Base Sandbox Image

Expand Down
Loading