← Back to PRs

#17098: docs: add xCloud hosting guide

by mosabbirrakib open 2026-02-15 12:04 View on GitHub →
docs stale size: XS
## Summary - Problem: xCloud hosting documentation was missing from the OpenClaw docs - Why it matters: Users deploying on xCloud need official documentation following the same format as other VPS providers (Railway, Northflank, etc.) - What changed: Added comprehensive xCloud hosting guide at docs/install/xcloud.mdx, updated VPS hub page to include xCloud, and added navigation entries in docs.json - What did NOT change: No code changes, only documentation additions ## Change Type (select all) - [x] Docs ## Scope (select all touched areas) - [x] UI / DX ## Linked Issue/PR - Related: N/A (community contribution) ## User-visible / Behavior Changes - New documentation page available at /install/xcloud - xCloud added to VPS hosting options on /vps page - Navigation updated to include xCloud in the hosting section - Redirects added for /xcloud and /platforms/xcloud ## Security Impact (required) - New permissions/capabilities? No - Secrets/tokens handling changed? No - New/changed network calls? No - Command/tool execution surface changed? No - Data access scope changed? No ## Repro + Verification ### Environment - Documentation only change - Verified Mintlify format matches existing docs (northflank.mdx, railway.mdx) ### Steps 1. Navigate to docs.openclaw.ai/vps 2. Click on xCloud link 3. Review xCloud hosting guide at docs.openclaw.ai/install/xcloud ### Expected - xCloud appears in VPS provider list - xCloud documentation page renders correctly with proper formatting - All internal and external links work properly - Navigation structure is consistent with other VPS providers ### Actual - Documentation follows established patterns - Formatting matches other VPS provider docs - Navigation structure is consistent - External links point to official xCloud resources ## Evidence - [x] Documentation follows existing format (northflank.mdx, railway.mdx) - [x] Added to navigation in docs.json - [x] Updated VPS hub page with xCloud entry - [x] Includes redirects for /xcloud and /platforms/xcloud - [x] External links added to official xCloud resources ## Human Verification (required) What you personally verified (not just CI), and how: - Verified scenarios: - Documentation structure matches existing VPS guides (Northflank, Railway) - All frontmatter is properly formatted (MDX format) - Content is comprehensive and follows OpenClaw documentation style - Navigation entries added correctly in docs.json - External links point to correct xCloud resources - Edge cases checked: - Redirect paths added for common URL patterns (/xcloud, /platforms/xcloud) - Proper ordering in VPS provider list (after Northflank, before Oracle) - MDX file extension used (consistent with other one-click deploy guides) - What you did **not** verify: - Live deployment on Mintlify (will be verified after merge) - Actual xCloud deployment flow (documentation based on provided guide) ## Compatibility / Migration - Backward compatible? Yes - Config/env changes? No - Migration needed? No ## Failure Recovery (if this breaks) - How to disable/revert this change quickly: Remove docs/install/xcloud.mdx and revert changes to docs/vps.md and docs/docs.json - Files/config to restore: - docs/vps.md (remove xCloud entry from provider list) - docs/docs.json (remove xCloud from navigation and redirects) - docs/install/xcloud.mdx (delete file) - Known bad symptoms reviewers should watch for: - Broken links in navigation - 404 errors on /install/xcloud - Formatting issues in Mintlify ## Risks and Mitigations - Risk: Documentation may not perfectly match actual xCloud implementation details - Mitigation: Based on official xCloud deployment guide provided by contributor; can be updated based on user feedback and xCloud team input - Risk: External links may change or break over time - Mitigation: Links point to official xCloud documentation and hosting pages; xCloud team can notify if URLs change <!-- greptile_comment --> <h3>Greptile Summary</h3> Adds a new xCloud hosting guide (`docs/install/xcloud.mdx`), updates the VPS hub page (`docs/vps.md`) to include xCloud in the provider list, and adds navigation entries and redirects in `docs/docs.json`. The guide covers managed VPS deployment through xCloud's dashboard, including server provisioning, AI provider configuration, Telegram integration, and post-deployment management. - Documentation-only change; no code modifications - Navigation and redirect entries follow established patterns (consistent with Railway, Northflank, etc.) - Previous review threads flagged issues with "Claude Code" incorrectly listed as an AI provider, a missing word ("if") on line 43, and redundant "optional" phrasing on line 28 — these should be addressed before merging <h3>Confidence Score: 4/5</h3> - Documentation-only PR with no code changes; safe to merge after addressing previously flagged text issues. - This is a docs-only change adding a new hosting guide. The navigation and redirect changes in docs.json and vps.md are clean and follow established patterns. The xcloud.mdx file has a few text issues (already flagged in previous review threads) that should be resolved, but none are blocking or introduce risk. No code, security, or runtime concerns. - `docs/install/xcloud.mdx` needs the previously flagged text corrections (Claude Code provider error, missing word, redundant phrasing) addressed before merge. <sub>Last reviewed commit: 38ac389</sub> <!-- greptile_other_comments_section --> <!-- /greptile_comment -->

Most Similar PRs