docs: Technical Reference tab + deep troubleshooting/recovery + llms.txt - #235
Merged
KrasimirKralev merged 3 commits intoJul 4, 2026
Merged
Conversation
Full documentation build-out, modeled on docs.openclaw.ai's structure (concepts/reference/symptom-first troubleshooting) and fact-checked against the codebase: - New 'Technical Reference' tab (8 pages): quick-reference (one-page ports/paths/services/commands/gotchas fact sheet — the anchor page), architecture (service topology, request routing, boot lifecycle), networking (AP mode, captive portal, mDNS reliability, port map), filesystem (on-disk layout, what survives updates vs factory reset), authentication (login flow, session cookies, gateway/MCP tokens), ai-providers (all lanes, credential storage map, the two OpenAI lanes, boot self-heals), update-system (tag-based updates, channels, divergence), agent-interface (full MCP tool catalog + clawbox CLI). - support/troubleshooting rewritten symptom-first with diagnostic ladders drawn from real support cases: browser-rejects-password (unix_chkpwd/ autofill/stale-build/encoding), silent update suppression on diverged boxes, manual-update pitfalls (gateway token mismatch, stale core), provider 401s after API-key->subscription switch, Telegram pairing. - New support/recovery: ordered playbook A-D (password reset, service restart, safe reinstall, factory reset incl. SSH path + post-reset steps). - llms.txt published at the site root (docs-deploy.yml copies it) for LLM/agent discovery per the llms.txt convention. - Beta-only features (updates-paused UI, provider self-heals) are labeled as beta-channel — v3.1.5 stable shipped without them. Validated: mint export builds 24 pages clean.
|
Warning Review limit reached
Next review available in: 25 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (25)
📝 WalkthroughWalkthroughThis PR adds a new "Technical Reference" documentation section (Architecture, Networking, Filesystem, Authentication, AI Providers, Update System, Agent Interface, Quick Reference), overhauls the Recovery and Troubleshooting support pages, adds an ChangesDocumentation site additions and overhaul
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
Suggested labels: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs-site/index.mdx`:
- Around line 57-67: The “Troubleshooting & Recovery” card in index.mdx only
points to the troubleshooting page, so users looking for recovery steps have to
take an extra hop. Update the existing Card in the Going deeper section to make
recovery directly accessible as well, using the Card component and its
href/label setup so the destination clearly surfaces both troubleshooting and
recovery content.
In `@docs-site/support/troubleshooting.mdx`:
- Around line 89-100: The “Rebuild the web app” step in troubleshooting
duplicates the reinstall instructions already maintained in the recovery guide,
so update the Step content in troubleshooting.mdx to point to the existing
`/support/recovery#c--safe-reinstall-1015-minutes-no-data-loss` section instead
of repeating the full command block. Keep the surrounding explanatory text, but
replace the duplicated snippet so future changes only need to be made in the
recovery page. Use the Step title and the recovery Option C anchor to locate the
duplicated block.
In `@docs-site/technical/networking.mdx`:
- Around line 13-24: The networking docs are hardcoding the default AP and LAN
URL targets instead of using the active fallback IP/hostname, which can be wrong
when the primary subnet collides or the hostname is renamed. Update the captive
portal and steady-state LAN references in networking.mdx to reflect the active
AP IP fallback behavior and the configurable hostname documented elsewhere, so
the docs match the runtime behavior of the AP/mDNS flow.
In `@docs-site/technical/quick-reference.mdx`:
- Line 100: Update the route examples in quick-reference so they include the
/setup-api/ prefix, since the current grouped paths in the table under the route
list can be mistaken for top-level endpoints. Adjust the markdown row containing
wifi/*, files/*, apps/*, clawkeep/*, code/*, and preferences so each example is
shown as a setup-api-prefixed route.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: a750f30d-28d9-4904-95d7-12c031041e95
📒 Files selected for processing (14)
.github/workflows/docs-deploy.ymldocs-site/docs.jsondocs-site/index.mdxdocs-site/llms.txtdocs-site/support/recovery.mdxdocs-site/support/troubleshooting.mdxdocs-site/technical/agent-interface.mdxdocs-site/technical/ai-providers.mdxdocs-site/technical/architecture.mdxdocs-site/technical/authentication.mdxdocs-site/technical/filesystem.mdxdocs-site/technical/networking.mdxdocs-site/technical/quick-reference.mdxdocs-site/technical/update-system.mdx
…fixes - Replace the ASCII architecture diagram with a native Mermaid flowchart (the box-drawing characters rendered misaligned; Mermaid is theme-aware and scrollbar-free) - Add consistent sidebar icons to all 23 pages (a mixed icon/no-icon sidebar reads as unfinished) - Shorten the ai-providers sidebar title; rename 'Deep Support' -> 'Support' - CodeRabbit review fixes: link Recovery from the landing card; de-duplicate the reinstall block (divergence fix now links to Recovery C; the login ladder keeps its inline copy deliberately - a stuck user shouldn't hop pages mid-diagnosis); acknowledge the active-AP-IP fallback in the networking table; add the /setup-api/ prefix to the grouped endpoint row - Verified: mint export builds 24 pages; mermaid compiles to the Mermaid component (not a plain code block); all internal links resolve
…x, dedup Findings from a 4-angle review (duplication, simplification, consistency, altitude) applied: Factual corrections: - The gateway is NOT loopback-only: clawbox-gateway.service runs --bind lan. Corrected the exposure claim in architecture (diagram + services table), networking, authentication, quick-reference, and llms.txt to 'LAN, token-gated - never browse :18789 directly'. - support/updating.mdx rewritten: it told users four times to click Connect at :18789 (the exact anti-pattern the rest of the docs warn against) and recommended curl|bash as the PRIMARY update path. Now: System Update app first, sudo clawbox update over SSH, force-update.sh as the stuck-update fallback; kept its unique ~/.openclaw backup step; fixed repo casing, service-name style, and the 10-15 min duration. - setup/openclaw-setup.mdx: 'systemctl restart openclaw' / 'journalctl -u openclaw' reference a unit that doesn't exist on a ClawBox - corrected to clawbox-gateway with a DIY note; Node 18+ -> 22+ (requirements.mdx 20+ -> 22+ and its self-contradicting 'Minimum requirements' heading renamed). Structure/ordering: - Login ladder: fresh-password (10s) now precedes the rebuild (10-15 min); rebuild step links to Recovery C instead of inlining the destructive recipe. - 'Update finished but misbehaves': full-installer guidance promoted to the intro; redundant 'Rule of thumb' accordion removed. - Provider-401 accordion trimmed to symptom+fix, links to ai-providers for the two-lanes explanation (was a full retelling). - Divergence beta note now links to update-system instead of duplicating it. - OpenClaw pinning prose deduped (was stated in full on two pages). - Credentials-location explanation single-sourced in ai-providers. - Anchor-safe heading rename: 'AI provider errors (401 "Incorrect API key")' (the ' / ' variant slugified inconsistently with its 3 inbound links). - first-boot title 'Setup Guide' -> 'First Boot' (matches every cross-link); llms.txt descriptions re-synced; index tightened + Discord link added; beta-availability phrasing standardized. Skipped deliberately (product-truth calls for @yalexx): box-contents/case- material discrepancies, ClawBox AI Free-tier mention in subscriptions.mdx, messaging-channels device-managed nuance, Orin Nano 'Super' naming. Validated: mint export 24 pages clean; all internal links resolve; zero :18789 browsing instructions remain.
This was referenced Aug 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Full documentation build-out for docs.clawbox.tech — technical reference, deep troubleshooting, and agent-scannability. Modeled on docs.openclaw.ai's structure (concepts / reference / symptom-first troubleshooting) and fact-checked against the codebase (service units, install.sh, updater.ts, auth.ts, configure/route.ts, gateway-pre-start.sh, clawbox-mcp.ts).
New: Technical Reference tab (8 pages)
clawbox.localreliability (why it fails, what to do), full port map, remote accessunix_chkpwdrequirements), session cookies, gateway token, MCP/local-AI tokens, security postureopenai/vscodex/), credential storage map, compat routing, boot-time self-healsclawboxCLI, auth modelUpgraded: Support
unix_chkpwdtest → login-API curl → perms → stale build → passwd reset), silent update suppression on diverged boxes,gateway token mismatch/Unrecognized keyafter manual updates, provider 401s after switching to the ChatGPT subscription, Telegram pairing.Agent scannability
llms.txtpublished at the site root (one-linedocs-deploy.ymladdition copies it into the export) — the standard LLM discovery index with per-page descriptions.Notes
mint exportbuilds all 24 pages clean (was 15)./llms.txt.Summary by CodeRabbit
New Features
Bug Fixes
llms.txtis included in the published site output.