mirror of
https://github.com/openclaw/openclaw.git
synced 2026-10-03 17:53:39 +00:00
fa3bc9a244
Closes link-kind audit findings for docs/install/, docs/help/, docs/reference/, docs/start/, docs/web/ and docs/nodes/. - start/hubs: point the Model providers hub entry at the provider directory (/providers) instead of the /providers/models quickstart duplicate. - Add the missing reciprocal links the audit found: Cloudflare Containers, Kubernetes and Ansible from Docker and the Linux server page; macOS VMs from iMessage and the Linux server page; Podman from the sandbox Podman backend; Updating from Migrating; Docker from the Configuration page; Backups, Bootstrapping and Default AGENTS.md from Agent workspace; Bootstrapping from the BOOTSTRAP template; Tests from the two help testing pages; Session management deep dive from Context engine; Transcript hygiene from Session and Session pruning; SecretRef credential surface from Auth credential semantics; Device model database from the Nodes macOS section; RPC adapters from Signal and iMessage; Personal assistant setup from Getting started; Onboarding from the macOS platform page; The Lobster from Control UI settings; Release performance sweep from Dependency locking; Release policy from Release channels; Full release validation and Update and plugin tests from RELEASING. - help/index: list the Scripts page under Testing. - help/faq-first-run: add the Models FAQ to Related (was one-directional). - reference/credits: replace the two off-topic Related links with the lore and pull-request-review-flow pages. - reference/rich-output-protocol: replace the unrelated RPC adapters link with the Control UI hosted-embeds section that actually renders [embed ...]. - web/lobster: add a Related section. - glossary: 17 append-only zh-CN sources for the new list-item link labels, each inserted beside a related existing term rather than at the end of the array.
1.8 KiB
1.8 KiB
| summary | read_when | title | ||
|---|---|---|---|---|
| Help hub: common fixes, install sanity, and where to look when something breaks |
|
Help |
Fastest path to unstuck, by symptom:
- Troubleshooting - symptom-first decision tree
- Debugging - watch mode, raw streams, dev profile
- Install sanity - Node / npm / PATH checks
- Gateway troubleshooting - gateway-specific issues
- Doctor -
openclaw doctor: health checks, config migrations, repair steps
FAQ
- FAQ - day-to-day concepts and operational questions
- First-run FAQ - install, onboard, auth, subscriptions, early failures
- Models FAQ - model selection, failover, auth profiles
Diagnostics
- Environment variables - where OpenClaw loads env vars and precedence
- Diagnostics flags - runtime diagnostics and verbose modes
- Node and tsx startup errors - capture runtime versions and the stack trace for startup failures
Testing
- Testing - test suites and Docker runners
- Update and plugin tests - package update, migration, and plugin install validation
- Live tests - network-touching provider and CLI smokes
- Scripts - helper scripts under
scripts/and when to prefer the CLI
Community and meta
- OpenClaw lore - the story
- Docs hubs - how this documentation is organized
- Docs directory - full file map