π OpenHands: AI-Driven Development
Fix some broken links (#9005)
mamoodi4eef22e04e69
diff --git a/docs/docs.json b/docs/docs.jsonindex c91d7064ed..f51db60f89 100644--- a/docs/docs.json+++ b/docs/docs.json@@ -42,7 +42,7 @@]},{- "group": "Running OpenHands Locally",+ "group": "Running OpenHands on Your Own","pages": ["usage/local-setup","usage/how-to/gui-mode",diff --git a/docs/usage/how-to/custom-sandbox-guide.mdx b/docs/usage/how-to/custom-sandbox-guide.mdxindex dc32910f31..12ec16e2d9 100644--- a/docs/usage/how-to/custom-sandbox-guide.mdx+++ b/docs/usage/how-to/custom-sandbox-guide.mdx@@ -46,7 +46,7 @@ This will produce a new image called `custom-image`, which will be available in## Using the Docker Command-When running OpenHands using [the docker command](/usage/installation#start-the-app), replace+When running OpenHands using [the docker command](/usage/local-setup#start-the-app), replace`-e SANDBOX_RUNTIME_CONTAINER_IMAGE=...` with `-e SANDBOX_BASE_CONTAINER_IMAGE=<custom image name>`:```commandlinediff --git a/docs/usage/how-to/github-action.mdx b/docs/usage/how-to/github-action.mdxindex 95cc12515e..d35bf3ed48 100644--- a/docs/usage/how-to/github-action.mdx+++ b/docs/usage/how-to/github-action.mdx@@ -48,6 +48,6 @@ The customization options you can set are:| `LLM_MODEL` | Variable | Set the LLM to use with OpenHands | `LLM_MODEL="anthropic/claude-3-5-sonnet-20241022"` || `OPENHANDS_MAX_ITER` | Variable | Set max limit for agent iterations | `OPENHANDS_MAX_ITER=10` || `OPENHANDS_MACRO` | Variable | Customize default macro for invoking the resolver | `OPENHANDS_MACRO=@resolveit` |-| `OPENHANDS_BASE_CONTAINER_IMAGE` | Variable | Custom Sandbox ([learn more](https://docs.all-hands.dev/modules/usage/how-to/custom-sandbox-guide)) | `OPENHANDS_BASE_CONTAINER_IMAGE="custom_image"` |+| `OPENHANDS_BASE_CONTAINER_IMAGE` | Variable | Custom Sandbox ([learn more](/usage/how-to/custom-sandbox-guide)) | `OPENHANDS_BASE_CONTAINER_IMAGE="custom_image"` || `TARGET_BRANCH` | Variable | Merge to branch other than `main` | `TARGET_BRANCH="dev"` || `TARGET_RUNNER` | Variable | Target runner to execute the agent workflow (default ubuntu-latest) | `TARGET_RUNNER="custom-runner"` |diff --git a/docs/usage/installation.mdx b/docs/usage/installation.mdxindex 6579025782..8e0ab99619 100644--- a/docs/usage/installation.mdx+++ b/docs/usage/installation.mdx@@ -16,4 +16,4 @@ For more information see [getting started with OpenHands Cloud.](/usage/cloud/opRun OpenHands on your local system and bring your own LLM and API key.-For more information see [running OpenHands locally.](/usage/local-setup)+For more information see [running OpenHands on your own.](/usage/local-setup)diff --git a/docs/usage/llms/local-llms.mdx b/docs/usage/llms/local-llms.mdxindex 7735f4f01d..3996fadb98 100644--- a/docs/usage/llms/local-llms.mdx+++ b/docs/usage/llms/local-llms.mdx@@ -48,7 +48,7 @@ We recommend using [LMStudio](https://lmstudio.ai/) for serving these models loc### Start OpenHands with locally served model-Check [the installation guide](https://docs.all-hands.dev/modules/usage/installation) to make sure you have all the prerequisites for running OpenHands.+Check [the installation guide](/usage/local-setup) to make sure you have all the prerequisites for running OpenHands.```bashexport LMSTUDIO_MODEL_NAME="imported-models/uncategorized/devstralq4_k_m.gguf" # <- Replace this with the model name you copied from LMStudiodiff --git a/frontend/src/components/shared/modals/settings/settings-form.tsx b/frontend/src/components/shared/modals/settings/settings-form.tsxindex d8d49e2da5..0c85530071 100644--- a/frontend/src/components/shared/modals/settings/settings-form.tsx+++ b/frontend/src/components/shared/modals/settings/settings-form.tsx@@ -96,7 +96,7 @@ export function SettingsForm({ settings, models, onClose }: SettingsFormProps) {testId="llm-api-key-help-anchor"text={t(I18nKey.SETTINGS$DONT_KNOW_API_KEY)}linkText={t(I18nKey.SETTINGS$CLICK_FOR_INSTRUCTIONS)}- href="https://docs.all-hands.dev/usage/installation#getting-an-api-key"+ href="https://docs.all-hands.dev/usage/local-setup#getting-an-api-key"/></div>diff --git a/frontend/src/routes/llm-settings.tsx b/frontend/src/routes/llm-settings.tsxindex bdcfbbc7a5..8a8d6bb412 100644--- a/frontend/src/routes/llm-settings.tsx+++ b/frontend/src/routes/llm-settings.tsx@@ -304,7 +304,7 @@ function LlmSettingsScreen() {testId="llm-api-key-help-anchor"text={t(I18nKey.SETTINGS$DONT_KNOW_API_KEY)}linkText={t(I18nKey.SETTINGS$CLICK_FOR_INSTRUCTIONS)}- href="https://docs.all-hands.dev/usage/installation#getting-an-api-key"+ href="https://docs.all-hands.dev/usage/local-setup#getting-an-api-key"/><SettingsInput@@ -379,7 +379,7 @@ function LlmSettingsScreen() {testId="llm-api-key-help-anchor-advanced"text={t(I18nKey.SETTINGS$DONT_KNOW_API_KEY)}linkText={t(I18nKey.SETTINGS$CLICK_FOR_INSTRUCTIONS)}- href="https://docs.all-hands.dev/usage/installation#getting-an-api-key"+ href="https://docs.all-hands.dev/usage/local-setup#getting-an-api-key"/><SettingsInputdiff --git a/frontend/src/utils/tips.ts b/frontend/src/utils/tips.tsindex a6eda139dc..063dd2473b 100644--- a/frontend/src/utils/tips.ts+++ b/frontend/src/utils/tips.ts@@ -12,7 +12,7 @@ export const TIPS: Tip[] = [},{key: I18nKey.TIPS$SETUP_SCRIPT,- link: "https://docs.all-hands.dev/usage/customization/repository",+ link: "https://docs.all-hands.dev/usage/prompting/repository#setup-script",},{ key: I18nKey.TIPS$VSCODE_INSTANCE },{ key: I18nKey.TIPS$SAVE_WORK },@@ -38,7 +38,7 @@ export const TIPS: Tip[] = [},{key: I18nKey.TIPS$API_USAGE,- link: "https://docs.all-hands.dev/swagger-ui/",+ link: "https://docs.all-hands.dev/api-reference/health-check",},];diff --git a/microagents/add_agent.md b/microagents/add_agent.mdindex 58997446ce..44316e1b5e 100644--- a/microagents/add_agent.md+++ b/microagents/add_agent.md@@ -37,5 +37,4 @@ When creating a new microagent:For detailed information, see:- [Microagents Overview](https://docs.all-hands.dev/usage/prompting/microagents-overview)-- [Microagents Syntax](https://docs.all-hands.dev/usage/prompting/microagents-syntax)- [Example GitHub Microagent](https://github.com/All-Hands-AI/OpenHands/blob/main/microagents/github.md)