docs: add Cloud JS SDK reference and migrate CLI docs#147
Merged
Conversation
Add @phala/cloud SDK documentation covering client creation, all available actions, API versioning (2026-01-21 / 2025-10-28), Zod schema reference, and error handling. Update CLI reference with versioning info, credential profiles, and global flags.
- Clarify that createClient already includes all actions; .extend() is for selective tree-shaking or custom actions with createBaseClient - Mark version-aware actions with **V** indicator in the actions table - Add note clarifying Error Handling vs Error Codes page relationship - Document --api-version global flag and phala.toml api_version field - Document all phala.toml fields with types and descriptions
…elogs Add 17 per-function SDK reference pages covering all @phala/cloud client methods with parameters, return types, and examples. Add on-chain KMS guide documenting the ETHEREUM/BASE deployment flow. Add changelogs for both the JS SDK and CLI.
Move 24 CLI command pages from phala-cloud/references/phala-cloud-cli/phala/ into phala-cloud/phala-cloud-cli/ to eliminate the redundant reference section. Merge the two overview pages into one. Update docs.json with grouped CLI navigation, expanded SDK reference section, and 26 redirect entries for old CLI paths. Update internal links and generation scripts.
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.
Summary
@phala/cloudcovering parameters, return types, and examples — grouped into individual pages (provisionCvm, commitCvmProvision, updateCvmEnvs, etc.) and topic pages (CVM query, lifecycle, configuration, KMS, apps, workspaces, SSH keys, nodes)references/phala-cloud-cli/phala/intophala-cloud-cli/, merge the two overview pages, add grouped navigation (Auth, Deployment, App Management, CVM Operations, Advanced)docs.jsonwith expanded SDK reference section, grouped CLI commands, and 26 redirect entries for old CLI pathsTest plan
docs.jsonis valid JSON and Mintlify build succeeds/phala-cloud/references/phala-cloud-cli/phala/deploy) redirect to new pathscvms.mdx,deploy.mdx,set-secure-environment-variables.mdx,enable-ssh-access.mdxresolve correctly