From 880c05ed94dd69a97b749d3f7ece43e9c5648487 Mon Sep 17 00:00:00 2001 From: llamantino <213239228+llamantino@users.noreply.github.com> Date: Sun, 1 Jun 2025 03:24:59 +0200 Subject: [PATCH] Fix all broken docs links across the project (#8830) Co-authored-by: llamantino <12345678+yourusername@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- Development.md | 2 +- .../current/usage/how-to/github-action.md | 2 +- .../current/usage/installation.mdx | 10 +++++----- .../current/usage/intro.mdx | 2 +- .../current/usage/how-to/github-action.md | 2 +- .../current/usage/installation.mdx | 10 +++++----- .../current/usage/intro.mdx | 2 +- .../current/usage/how-to/github-action.md | 2 +- .../current/usage/installation.mdx | 10 +++++----- .../current/usage/custom_sandbox_guide.md | 2 +- .../current/usage/how-to/github-action.md | 2 +- .../current/usage/installation.mdx | 10 +++++----- .../current/usage/intro.mdx | 2 +- docs/modules/usage/how-to/github-action.md | 2 +- docs/modules/usage/installation.mdx | 10 +++++----- docs/modules/usage/llms/local-llms.md | 2 +- evaluation/README.md | 2 +- .../features/settings/api-keys-manager.test.tsx | 2 +- .../src/components/features/home/home-header.tsx | 2 +- .../features/settings/api-keys-manager.tsx | 2 +- .../settings/mcp-settings/mcp-config-editor.tsx | 2 +- .../settings/mcp-settings/mcp-config-viewer.tsx | 2 +- frontend/src/components/shared/hero-heading.tsx | 2 +- .../src/components/shared/inputs/api-key-input.tsx | 2 +- .../shared/modals/settings/settings-form.tsx | 2 +- frontend/src/routes/llm-settings.tsx | 4 ++-- frontend/src/utils/tips.ts | 12 ++++++------ microagents/add_agent.md | 4 ++-- openhands/README.md | 2 +- openhands/cli/tui.py | 2 +- openhands/core/const/guide_url.py | 2 +- openhands/resolver/README.md | 2 +- openhands/runtime/README.md | 2 +- openhands/runtime/utils/runtime_build.py | 2 +- 35 files changed, 62 insertions(+), 62 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ffc73c9c6..994d0c4ef8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ We have a separate doc [Development.md](https://github.com/All-Hands-AI/OpenHand There are many ways that you can contribute: 1. **Download and use** OpenHands, and send [issues](https://github.com/All-Hands-AI/OpenHands/issues) when you encounter something that isn't working or a feature that you'd like to see. -2. **Send feedback** after each session by [clicking the thumbs-up thumbs-down buttons](https://docs.all-hands.dev/modules/usage/feedback), so we can see where things are working and failing, and also build an open dataset for training code agents. +2. **Send feedback** after each session by [clicking the thumbs-up thumbs-down buttons](https://docs.all-hands.dev/usage/feedback), so we can see where things are working and failing, and also build an open dataset for training code agents. 3. **Improve the Codebase** by sending [PRs](#sending-pull-requests-to-openhands) (see details below). In particular, we have some [good first issues](https://github.com/All-Hands-AI/OpenHands/labels/good%20first%20issue) that may be ones to start on. ## What Can I Build? diff --git a/Development.md b/Development.md index b150db84aa..e098ba3212 100644 --- a/Development.md +++ b/Development.md @@ -76,7 +76,7 @@ variables in your terminal. The final configurations are set from highest to low Environment variables > config.toml variables > default variables **Note on Alternative Models:** -See [our documentation](https://docs.all-hands.dev/modules/usage/llms) for recommended models. +See [our documentation](https://docs.all-hands.dev/usage/llms) for recommended models. ### 4. Running the application diff --git a/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md b/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md index 9bf02c6fd2..e70013b9b8 100644 --- a/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md +++ b/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md @@ -47,5 +47,5 @@ Les options de personnalisation que vous pouvez définir sont : | `LLM_MODEL` | Variable | Définir le LLM à utiliser avec OpenHands | `LLM_MODEL="anthropic/claude-3-5-sonnet-20241022"` | | `OPENHANDS_MAX_ITER` | Variable | Définir la limite maximale d'itérations de l'agent | `OPENHANDS_MAX_ITER=10` | | `OPENHANDS_MACRO` | Variable | Personnaliser la macro par défaut pour invoquer le résolveur | `OPENHANDS_MACRO=@resolveit` | -| `OPENHANDS_BASE_CONTAINER_IMAGE` | Variable | Sandbox personnalisé ([en savoir plus](https://docs.all-hands.dev/modules/usage/how-to/custom-sandbox-guide)) | `OPENHANDS_BASE_CONTAINER_IMAGE="custom_image"` | +| `OPENHANDS_BASE_CONTAINER_IMAGE` | Variable | Sandbox personnalisé ([en savoir plus](https://docs.all-hands.dev/usage/how-to/custom-sandbox-guide)) | `OPENHANDS_BASE_CONTAINER_IMAGE="custom_image"` | | `TARGET_BRANCH` | Variable | Fusionner vers une branche autre que `main` | `TARGET_BRANCH="dev"` | diff --git a/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/installation.mdx b/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/installation.mdx index 68dbe576f2..0e8714aaad 100644 --- a/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/installation.mdx +++ b/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/installation.mdx @@ -73,10 +73,10 @@ docker run -it --rm --pull=always \ Vous trouverez OpenHands en cours d'exécution à l'adresse http://localhost:3000 ! -Vous pouvez également [connecter OpenHands à votre système de fichiers local](https://docs.all-hands.dev/modules/usage/runtimes/docker#connecting-to-your-filesystem), -exécuter OpenHands en [mode headless](https://docs.all-hands.dev/modules/usage/how-to/headless-mode) scriptable, -interagir avec lui via une [CLI conviviale](https://docs.all-hands.dev/modules/usage/how-to/cli-mode), -ou l'exécuter sur des problèmes étiquetés avec [une action GitHub](https://docs.all-hands.dev/modules/usage/how-to/github-action). +Vous pouvez également [connecter OpenHands à votre système de fichiers local](https://docs.all-hands.dev/usage/runtimes/docker#connecting-to-your-filesystem), +exécuter OpenHands en [mode headless](https://docs.all-hands.dev/usage/how-to/headless-mode) scriptable, +interagir avec lui via une [CLI conviviale](https://docs.all-hands.dev/usage/how-to/cli-mode), +ou l'exécuter sur des problèmes étiquetés avec [une action GitHub](https://docs.all-hands.dev/usage/how-to/github-action). ## Configuration @@ -118,4 +118,4 @@ Cette version est instable et est recommandée uniquement à des fins de test ou Pour le flux de travail de développement, consultez [Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md). -Vous rencontrez des problèmes ? Consultez notre [Guide de dépannage](https://docs.all-hands.dev/modules/usage/troubleshooting). +Vous rencontrez des problèmes ? Consultez notre [Guide de dépannage](https://docs.all-hands.dev/usage/troubleshooting). diff --git a/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/intro.mdx b/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/intro.mdx index c09eb6b250..ccb8af7822 100644 --- a/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/intro.mdx +++ b/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/intro.mdx @@ -91,7 +91,7 @@ Si vous souhaitez utiliser la version **(instable !)** la plus récente, vous po Pour le workflow de développement, consultez [Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md). -Avez-vous des problèmes ? Consultez notre [Guide de dépannage](https://docs.all-hands.dev/modules/usage/troubleshooting). +Avez-vous des problèmes ? Consultez notre [Guide de dépannage](https://docs.all-hands.dev/usage/troubleshooting). :::warning OpenHands est actuellement en cours de développement, mais vous pouvez déjà exécuter la version alpha pour voir le système de bout en bout en action. diff --git a/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md b/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md index 3e8dc8b921..b614f9a379 100644 --- a/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md +++ b/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md @@ -47,5 +47,5 @@ GitHub resolverは、動作をカスタマイズするために有効な[リポ | `LLM_MODEL` | 変数 | OpenHandsで使用するLLMを設定 | `LLM_MODEL="anthropic/claude-3-5-sonnet-20241022"` | | `OPENHANDS_MAX_ITER` | 変数 | エージェントの反復回数の最大制限を設定 | `OPENHANDS_MAX_ITER=10` | | `OPENHANDS_MACRO` | 変数 | リゾルバーを呼び出すためのデフォルトマクロをカスタマイズ | `OPENHANDS_MACRO=@resolveit` | -| `OPENHANDS_BASE_CONTAINER_IMAGE` | 変数 | カスタムサンドボックス（[詳細](https://docs.all-hands.dev/modules/usage/how-to/custom-sandbox-guide)） | `OPENHANDS_BASE_CONTAINER_IMAGE="custom_image"` | +| `OPENHANDS_BASE_CONTAINER_IMAGE` | 変数 | カスタムサンドボックス（[詳細](https://docs.all-hands.dev/usage/how-to/custom-sandbox-guide)） | `OPENHANDS_BASE_CONTAINER_IMAGE="custom_image"` | | `TARGET_BRANCH` | 変数 | `main`以外のブランチにマージ | `TARGET_BRANCH="dev"` | diff --git a/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/installation.mdx b/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/installation.mdx index 9de2b79bd2..8bbcd014a6 100644 --- a/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/installation.mdx +++ b/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/installation.mdx @@ -73,10 +73,10 @@ docker run -it --rm --pull=always \ OpenHandsは http://localhost:3000 で実行されています！ -また、[OpenHandsをローカルファイルシステムに接続](https://docs.all-hands.dev/modules/usage/runtimes/docker#connecting-to-your-filesystem)したり、 -OpenHandsを[ヘッドレスモード](https://docs.all-hands.dev/modules/usage/how-to/headless-mode)でスクリプト実行したり、 -[使いやすいCLI](https://docs.all-hands.dev/modules/usage/how-to/cli-mode)を介して操作したり、 -[GitHubアクション](https://docs.all-hands.dev/modules/usage/how-to/github-action)でタグ付けされた課題に対して実行したりすることもできます。 +また、[OpenHandsをローカルファイルシステムに接続](https://docs.all-hands.dev/usage/runtimes/docker#connecting-to-your-filesystem)したり、 +OpenHandsを[ヘッドレスモード](https://docs.all-hands.dev/usage/how-to/headless-mode)でスクリプト実行したり、 +[使いやすいCLI](https://docs.all-hands.dev/usage/how-to/cli-mode)を介して操作したり、 +[GitHubアクション](https://docs.all-hands.dev/usage/how-to/github-action)でタグ付けされた課題に対して実行したりすることもできます。 ## セットアップ @@ -117,4 +117,4 @@ SemVerを使用しているため、`0.9`は自動的に最新の`0.9.x`リリ 開発ワークフローについては、[Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md)を参照してください。 -問題がありますか？[トラブルシューティングガイド](https://docs.all-hands.dev/modules/usage/troubleshooting)をご確認ください。 +問題がありますか？[トラブルシューティングガイド](https://docs.all-hands.dev/usage/troubleshooting)をご確認ください。 diff --git a/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/intro.mdx b/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/intro.mdx index e5cc0abe7c..3bfb4d3dc1 100644 --- a/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/intro.mdx +++ b/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/intro.mdx @@ -91,7 +91,7 @@ OpenHandsはこのワークスペースフォルダにのみアクセスでき 開発ワークフローについては、[Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md)を参照してください。 -問題がありますか？[トラブルシューティングガイド](https://docs.all-hands.dev/modules/usage/troubleshooting)をご確認ください。 +問題がありますか？[トラブルシューティングガイド](https://docs.all-hands.dev/usage/troubleshooting)をご確認ください。 :::warning OpenHandsは現在開発中ですが、アルファ版を実行してエンドツーエンドのシステムを動作させることができます。 diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md index d9073fa5e6..c67d967f58 100644 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md +++ b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md @@ -47,5 +47,5 @@ As opções de personalização que você pode definir são: | `LLM_MODEL` | Variável | Define o LLM a ser usado com OpenHands | `LLM_MODEL="anthropic/claude-3-5-sonnet-20241022"` | | `OPENHANDS_MAX_ITER` | Variável | Define o limite máximo para iterações do agente | `OPENHANDS_MAX_ITER=10` | | `OPENHANDS_MACRO` | Variável | Personaliza a macro padrão para invocar o resolver | `OPENHANDS_MACRO=@resolveit` | -| `OPENHANDS_BASE_CONTAINER_IMAGE` | Variável | Sandbox personalizado ([saiba mais](https://docs.all-hands.dev/modules/usage/how-to/custom-sandbox-guide)) | `OPENHANDS_BASE_CONTAINER_IMAGE="custom_image"` | +| `OPENHANDS_BASE_CONTAINER_IMAGE` | Variável | Sandbox personalizado ([saiba mais](https://docs.all-hands.dev/usage/how-to/custom-sandbox-guide)) | `OPENHANDS_BASE_CONTAINER_IMAGE="custom_image"` | | `TARGET_BRANCH` | Variável | Mesclar para uma branch diferente de `main` | `TARGET_BRANCH="dev"` | diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/installation.mdx b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/installation.mdx index 77157d4af9..f238ddeb13 100644 --- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/installation.mdx +++ b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/installation.mdx @@ -73,10 +73,10 @@ docker run -it --rm --pull=always \ Você encontrará o OpenHands rodando em http://localhost:3000! -Você também pode [conectar o OpenHands ao seu sistema de arquivos local](https://docs.all-hands.dev/modules/usage/runtimes/docker#connecting-to-your-filesystem), -executar o OpenHands em um [modo headless](https://docs.all-hands.dev/modules/usage/how-to/headless-mode) programável, -interagir com ele através de uma [CLI amigável](https://docs.all-hands.dev/modules/usage/how-to/cli-mode), -ou executá-lo em issues marcadas com [uma ação do GitHub](https://docs.all-hands.dev/modules/usage/how-to/github-action). +Você também pode [conectar o OpenHands ao seu sistema de arquivos local](https://docs.all-hands.dev/usage/runtimes/docker#connecting-to-your-filesystem), +executar o OpenHands em um [modo headless](https://docs.all-hands.dev/usage/how-to/headless-mode) programável, +interagir com ele através de uma [CLI amigável](https://docs.all-hands.dev/usage/how-to/cli-mode), +ou executá-lo em issues marcadas com [uma ação do GitHub](https://docs.all-hands.dev/usage/how-to/github-action). ## Configuração @@ -118,4 +118,4 @@ Esta versão é instável e é recomendada apenas para fins de teste ou desenvol Para o fluxo de trabalho de desenvolvimento, consulte [Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md). -Está tendo problemas? Confira nosso [Guia de Solução de Problemas](https://docs.all-hands.dev/modules/usage/troubleshooting). +Está tendo problemas? Confira nosso [Guia de Solução de Problemas](https://docs.all-hands.dev/usage/troubleshooting). diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/custom_sandbox_guide.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/custom_sandbox_guide.md index 55a0a6e44f..ec5c5662a2 100644 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/custom_sandbox_guide.md +++ b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/custom_sandbox_guide.md @@ -78,7 +78,7 @@ base_container_image="custom_image" ## 技术解释 -请参考[运行时文档中自定义 Docker 镜像的章节](https://docs.all-hands.dev/modules/usage/architecture/runtime#advanced-how-openhands-builds-and-maintains-od-runtime-images)获取更详细的解释。 +请参考[运行时文档中自定义 Docker 镜像的章节](https://docs.all-hands.dev/usage/architecture/runtime#advanced-how-openhands-builds-and-maintains-od-runtime-images)获取更详细的解释。 ## 故障排除 / 错误 diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md index 92533dbdda..b192774ecf 100644 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md +++ b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/how-to/github-action.md @@ -47,5 +47,5 @@ GitHub resolver 将自动检查有效的[仓库密钥](https://docs.github.com/e | `LLM_MODEL` | 变量 | 设置与 OpenHands 一起使用的 LLM | `LLM_MODEL="anthropic/claude-3-5-sonnet-20241022"` | | `OPENHANDS_MAX_ITER` | 变量 | 设置代理迭代的最大限制 | `OPENHANDS_MAX_ITER=10` | | `OPENHANDS_MACRO` | 变量 | 自定义用于调用 resolver 的默认宏 | `OPENHANDS_MACRO=@resolveit` | -| `OPENHANDS_BASE_CONTAINER_IMAGE` | 变量 | 自定义沙箱（[了解更多](https://docs.all-hands.dev/modules/usage/how-to/custom-sandbox-guide)） | `OPENHANDS_BASE_CONTAINER_IMAGE="custom_image"` | +| `OPENHANDS_BASE_CONTAINER_IMAGE` | 变量 | 自定义沙箱（[了解更多](https://docs.all-hands.dev/usage/how-to/custom-sandbox-guide)） | `OPENHANDS_BASE_CONTAINER_IMAGE="custom_image"` | | `TARGET_BRANCH` | 变量 | 合并到 `main` 以外的分支 | `TARGET_BRANCH="dev"` | diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/installation.mdx b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/installation.mdx index a71e1ded1a..ffc3b74cc3 100644 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/installation.mdx +++ b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/installation.mdx @@ -73,10 +73,10 @@ docker run -it --rm --pull=always \ OpenHands 将在 http://localhost:3000 运行！ -你还可以[将 OpenHands 连接到本地文件系统](https://docs.all-hands.dev/modules/usage/runtimes/docker#connecting-to-your-filesystem)， -以[无头模式](https://docs.all-hands.dev/modules/usage/how-to/headless-mode)运行 OpenHands， -通过[友好的 CLI](https://docs.all-hands.dev/modules/usage/how-to/cli-mode)与其交互， -或者使用 [GitHub action](https://docs.all-hands.dev/modules/usage/how-to/github-action) 在标记的问题上运行它。 +你还可以[将 OpenHands 连接到本地文件系统](https://docs.all-hands.dev/usage/runtimes/docker#connecting-to-your-filesystem)， +以[无头模式](https://docs.all-hands.dev/usage/how-to/headless-mode)运行 OpenHands， +通过[友好的 CLI](https://docs.all-hands.dev/usage/how-to/cli-mode)与其交互， +或者使用 [GitHub action](https://docs.all-hands.dev/usage/how-to/github-action) 在标记的问题上运行它。 ## 设置 @@ -116,4 +116,4 @@ OpenHands 需要 API 密钥才能访问大多数语言模型。以下是从推 有关开发工作流程，请参阅 [Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md)。 -遇到问题？请查看我们的[故障排除指南](https://docs.all-hands.dev/modules/usage/troubleshooting)。 +遇到问题？请查看我们的[故障排除指南](https://docs.all-hands.dev/usage/troubleshooting)。 diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/intro.mdx b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/intro.mdx index 7e30ef8352..8110b8ffb4 100644 --- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/intro.mdx +++ b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/intro.mdx @@ -91,7 +91,7 @@ OpenHands 只会访问这个工作区文件夹。它在一个安全的 docker 有关开发工作流程，请参阅 [Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md)。 -遇到问题了吗？查看我们的 [故障排除指南](https://docs.all-hands.dev/modules/usage/troubleshooting)。 +遇到问题了吗？查看我们的 [故障排除指南](https://docs.all-hands.dev/usage/troubleshooting)。 :::warning OpenHands 目前正在开发中，但你已经可以运行 alpha 版本来查看端到端系统的运作情况。 diff --git a/docs/modules/usage/how-to/github-action.md b/docs/modules/usage/how-to/github-action.md index 2c985eec62..b142928972 100644 --- a/docs/modules/usage/how-to/github-action.md +++ b/docs/modules/usage/how-to/github-action.md @@ -47,6 +47,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](https://docs.all-hands.dev/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/modules/usage/installation.mdx b/docs/modules/usage/installation.mdx index 56f2465d9a..9f84389838 100644 --- a/docs/modules/usage/installation.mdx +++ b/docs/modules/usage/installation.mdx @@ -78,10 +78,10 @@ docker run -it --rm --pull=always \ You'll find OpenHands running at http://localhost:3000! -You can also [connect OpenHands to your local filesystem](https://docs.all-hands.dev/modules/usage/runtimes/docker#connecting-to-your-filesystem), -run OpenHands in a scriptable [headless mode](https://docs.all-hands.dev/modules/usage/how-to/headless-mode), -interact with it via a [friendly CLI](https://docs.all-hands.dev/modules/usage/how-to/cli-mode), -or run it on tagged issues with [a GitHub action](https://docs.all-hands.dev/modules/usage/how-to/github-action). +You can also [connect OpenHands to your local filesystem](https://docs.all-hands.dev/usage/runtimes/docker#connecting-to-your-filesystem), +run OpenHands in a scriptable [headless mode](https://docs.all-hands.dev/usage/how-to/headless-mode), +interact with it via a [friendly CLI](https://docs.all-hands.dev/usage/how-to/cli-mode), +or run it on tagged issues with [a GitHub action](https://docs.all-hands.dev/usage/how-to/github-action). ## Setup @@ -123,4 +123,4 @@ This version is unstable and is recommended for testing or development purposes For the development workflow, see [Development.md](https://github.com/All-Hands-AI/OpenHands/blob/main/Development.md). -Are you having trouble? Check out our [Troubleshooting Guide](https://docs.all-hands.dev/modules/usage/troubleshooting). +Are you having trouble? Check out our [Troubleshooting Guide](https://docs.all-hands.dev/usage/troubleshooting). diff --git a/docs/modules/usage/llms/local-llms.md b/docs/modules/usage/llms/local-llms.md index f9fd17b322..d7e6aab813 100644 --- a/docs/modules/usage/llms/local-llms.md +++ b/docs/modules/usage/llms/local-llms.md @@ -50,7 +50,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](https://docs.all-hands.dev/usage/installation) to make sure you have all the prerequisites for running OpenHands. ```bash export LMSTUDIO_MODEL_NAME="imported-models/uncategorized/devstralq4_k_m.gguf" # <- Replace this with the model name you copied from LMStudio diff --git a/evaluation/README.md b/evaluation/README.md index 91d608d8f5..b0cddcbea5 100644 --- a/evaluation/README.md +++ b/evaluation/README.md @@ -120,7 +120,7 @@ You can start your own fork of [our huggingface evaluation outputs](https://hugg ## For Benchmark Developers -To learn more about how to integrate your benchmark into OpenHands, check out [tutorial here](https://docs.all-hands.dev/modules/usage/how-to/evaluation-harness). Briefly, +To learn more about how to integrate your benchmark into OpenHands, check out [tutorial here](https://docs.all-hands.dev/usage/how-to/evaluation-harness). Briefly, - Each subfolder contains a specific benchmark or experiment. For example, [`evaluation/benchmarks/swe_bench`](./benchmarks/swe_bench) should contain all the preprocessing/evaluation/analysis scripts. diff --git a/frontend/__tests__/components/features/settings/api-keys-manager.test.tsx b/frontend/__tests__/components/features/settings/api-keys-manager.test.tsx index 2f8570e859..711c50a194 100644 --- a/frontend/__tests__/components/features/settings/api-keys-manager.test.tsx +++ b/frontend/__tests__/components/features/settings/api-keys-manager.test.tsx @@ -52,7 +52,7 @@ describe("ApiKeysManager", () => { // Find the link to the API documentation const link = screen.getByRole("link"); expect(link).toBeInTheDocument(); - expect(link).toHaveAttribute("href", "https://docs.all-hands.dev/modules/usage/cloud/cloud-api"); + expect(link).toHaveAttribute("href", "https://docs.all-hands.dev/usage/cloud/cloud-api"); expect(link).toHaveAttribute("target", "_blank"); expect(link).toHaveAttribute("rel", "noopener noreferrer"); }); diff --git a/frontend/src/components/features/home/home-header.tsx b/frontend/src/components/features/home/home-header.tsx index 176421c9ce..cf04a167ae 100644 --- a/frontend/src/components/features/home/home-header.tsx +++ b/frontend/src/components/features/home/home-header.tsx @@ -43,7 +43,7 @@ export function HomeHeader() {

{t("HOME$NOT_SURE_HOW_TO_START")}{" "}

{t(I18nKey.LANDING$START_HELP_LINK)} diff --git a/frontend/src/components/shared/inputs/api-key-input.tsx b/frontend/src/components/shared/inputs/api-key-input.tsx index b7a01b93c7..7287bb0d62 100644 --- a/frontend/src/components/shared/inputs/api-key-input.tsx +++ b/frontend/src/components/shared/inputs/api-key-input.tsx @@ -39,7 +39,7 @@ export function APIKeyInput({ isDisabled, isSet }: APIKeyInputProps) {

{t(I18nKey.API$DONT_KNOW_KEY)}{" "}

diff --git a/frontend/src/routes/llm-settings.tsx b/frontend/src/routes/llm-settings.tsx index 9c719519c9..29ae2a4c93 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/modules/usage/installation#getting-an-api-key" + href="https://docs.all-hands.dev/usage/installation#getting-an-api-key" /> None: # Footer print_formatted_text( HTML( - 'Learn more at: https://docs.all-hands.dev/modules/usage/getting-started' + 'Learn more at: https://docs.all-hands.dev/usage/getting-started' ) ) diff --git a/openhands/core/const/guide_url.py b/openhands/core/const/guide_url.py index c401de8bb6..62af6e5475 100644 --- a/openhands/core/const/guide_url.py +++ b/openhands/core/const/guide_url.py @@ -1 +1 @@ -TROUBLESHOOTING_URL = 'https://docs.all-hands.dev/modules/usage/troubleshooting' +TROUBLESHOOTING_URL = 'https://docs.all-hands.dev/usage/troubleshooting' diff --git a/openhands/resolver/README.md b/openhands/resolver/README.md index 29c43398f1..1e7612c61c 100644 --- a/openhands/resolver/README.md +++ b/openhands/resolver/README.md @@ -40,7 +40,7 @@ Follow these steps to use this workflow in your own repository: Note: You can set these secrets at the organization level to use across multiple repositories. -6. Set up any [custom configurations required](https://docs.all-hands.dev/modules/usage/how-to/github-action#custom-configurations) +6. Set up any [custom configurations required](https://docs.all-hands.dev/usage/how-to/github-action#custom-configurations) 7. Usage: There are two ways to trigger the OpenHands agent: diff --git a/openhands/runtime/README.md b/openhands/runtime/README.md index 61347656b5..69501f31ad 100644 --- a/openhands/runtime/README.md +++ b/openhands/runtime/README.md @@ -3,7 +3,7 @@ ## Introduction The OpenHands Runtime folder contains the core components responsible for executing actions and managing the runtime environment for the OpenHands project. This README provides an overview of the main components and their interactions. -You can learn more about how the runtime works in the [Docker Runtime](https://docs.all-hands.dev/modules/usage/architecture/runtime) documentation. +You can learn more about how the runtime works in the [Docker Runtime](https://docs.all-hands.dev/usage/architecture/runtime) documentation. ## Main Components diff --git a/openhands/runtime/utils/runtime_build.py b/openhands/runtime/utils/runtime_build.py index 0f2b26174d..ff85c7d681 100644 --- a/openhands/runtime/utils/runtime_build.py +++ b/openhands/runtime/utils/runtime_build.py @@ -129,7 +129,7 @@ def build_runtime_image( Returns: - str: :. Where MD5 hash is the hash of the docker build folder - See https://docs.all-hands.dev/modules/usage/architecture/runtime for more details. + See https://docs.all-hands.dev/usage/architecture/runtime for more details. """ if build_folder is None: with tempfile.TemporaryDirectory() as temp_dir: