diff --git a/.openclaw-sync/source.json b/.openclaw-sync/source.json index c35bb9755..1ffd9fe7a 100644 --- a/.openclaw-sync/source.json +++ b/.openclaw-sync/source.json @@ -1,5 +1,5 @@ { "repository": "openclaw/openclaw", - "sha": "972c7112a292f2776b8008b8c0e311e64569236f", - "syncedAt": "2026-04-24T06:38:26.026Z" + "sha": "925d11d89054c5dd1ba31de5537d2ee3cb5cdd3b", + "syncedAt": "2026-04-24T06:43:03.131Z" } diff --git a/docs/help/faq.md b/docs/help/faq.md index cc47353e3..d5d8487bd 100644 --- a/docs/help/faq.md +++ b/docs/help/faq.md @@ -76,9 +76,8 @@ Quick answers plus deeper troubleshooting for real-world setups (local dev, VPS, ## Quick start and first-run setup -First-run setup Q&A — install, onboard, auth routes, subscriptions, initial -failures — moved to a dedicated page: -[FAQ — quick start and first-run setup](/help/faq-first-run). +First-run Q&A — install, onboard, auth routes, subscriptions, initial failures — +lives on the [First-run FAQ](/help/faq-first-run). ## What is OpenClaw? @@ -1380,8 +1379,7 @@ failures — moved to a dedicated page: ## Models, failover, and auth profiles Model Q&A — defaults, selection, aliases, switching, failover, auth profiles — -moved to a dedicated page: -[FAQ — models and auth profiles](/help/faq-models). +lives on the [Models FAQ](/help/faq-models). ## Gateway: ports, "already running", and remote mode @@ -1970,6 +1968,6 @@ Still stuck? Ask in [Discord](https://discord.com/invite/clawd) or open a [GitHu ## Related -- [FAQ — quick start and first-run setup](/help/faq-first-run) -- [FAQ — models and auth profiles](/help/faq-models) -- [Troubleshooting](/help/troubleshooting) +- [First-run FAQ](/help/faq-first-run) — install, onboard, auth, subscriptions, early failures +- [Models FAQ](/help/faq-models) — model selection, failover, auth profiles +- [Troubleshooting](/help/troubleshooting) — symptom-first triage diff --git a/docs/help/index.md b/docs/help/index.md index ce13cac31..1f3f6b1d3 100644 --- a/docs/help/index.md +++ b/docs/help/index.md @@ -1,26 +1,38 @@ --- summary: "Help hub: common fixes, install sanity, and where to look when something breaks" read_when: - - You’re new and want the “what do I click/run” guide + - You are new and want a "what do I click/run" guide - Something broke and you want the fastest path to a fix title: "Help" --- -If you want a quick “get unstuck” flow, start here: +Quick "get unstuck" path for the most common problems: -- **Troubleshooting:** [Start here](/help/troubleshooting) -- **Install sanity (Node/npm/PATH):** [Install](/install/node#troubleshooting) -- **Gateway issues:** [Gateway troubleshooting](/gateway/troubleshooting) -- **Logs:** [Logging](/logging) and [Gateway logging](/gateway/logging) -- **Repairs:** [Doctor](/gateway/doctor) +- [Troubleshooting](/help/troubleshooting) — symptom-first decision tree +- [Debugging](/help/debugging) — watch mode, raw streams, dev profile +- [Install sanity](/install/node#troubleshooting) — Node / npm / PATH checks +- [Gateway troubleshooting](/gateway/troubleshooting) — gateway-specific issues +- [Doctor](/gateway/doctor) — automated repair + diagnostic bundle -If you’re looking for conceptual questions (not “something broke”): +## FAQ -- [FAQ (concepts)](/help/faq) +- [FAQ](/help/faq) — day-to-day concepts and operational questions +- [First-run FAQ](/help/faq-first-run) — install, onboard, auth, subscriptions, early failures +- [Models FAQ](/help/faq-models) — model selection, failover, auth profiles -## Environment and debugging +## Diagnostics -- **Environment variables:** [Where OpenClaw loads env vars and precedence](/help/environment) -- **Debugging:** [Watch mode, raw streams, and dev profile](/help/debugging) -- **Testing:** [Test suites, live tests, and Docker runners](/help/testing) -- **Scripts:** [Repository helper scripts](/help/scripts) +- [Environment variables](/help/environment) — where OpenClaw loads env vars and precedence +- [Diagnostics flags](/diagnostics/flags) — runtime diagnostics and verbose modes +- [Node + tsx crash](/debug/node-issue) — specific Node / tsx runtime crash scenarios + +## Testing + +- [Testing](/help/testing) — test suites and Docker runners +- [Live tests](/help/testing-live) — network-touching provider and CLI smokes + +## Community and meta + +- [OpenClaw lore](/start/lore) — the story +- [Docs hubs](/start/hubs) — how this documentation is organized +- [Docs directory](/start/docs-directory) — full file map diff --git a/docs/help/troubleshooting.md b/docs/help/troubleshooting.md index 27f361f25..1781865e8 100644 --- a/docs/help/troubleshooting.md +++ b/docs/help/troubleshooting.md @@ -6,8 +6,6 @@ read_when: title: "General troubleshooting" --- -# Troubleshooting - If you only have 2 minutes, use this page as a triage front door. ## First 60 seconds diff --git a/docs/plugins/sdk-subpaths.md b/docs/plugins/sdk-subpaths.md index 51d86db06..a52cc263d 100644 --- a/docs/plugins/sdk-subpaths.md +++ b/docs/plugins/sdk-subpaths.md @@ -189,7 +189,7 @@ For the plugin authoring guide, see [Plugin SDK overview](/plugins/sdk-overview) | `plugin-sdk/models-provider-runtime` | `/models` command/provider reply helpers | | `plugin-sdk/skill-commands-runtime` | Skill command listing helpers | | `plugin-sdk/native-command-registry` | Native command registry/build/serialize helpers | - | `plugin-sdk/agent-harness` | Experimental trusted-plugin surface for low-level agent harnesses: harness types, active-run steer/abort helpers, OpenClaw tool bridge helpers, and attempt result utilities | + | `plugin-sdk/agent-harness` | Experimental trusted-plugin surface for low-level agent harnesses: harness types, active-run steer/abort helpers, OpenClaw tool bridge helpers, tool progress formatting/detail helpers, and attempt result utilities | | `plugin-sdk/provider-zai-endpoint` | Z.AI endpoint detection helpers | | `plugin-sdk/infra-runtime` | System event/heartbeat helpers | | `plugin-sdk/collection-runtime` | Small bounded cache helpers |