Conversation
- JS SDK v0.2.7 - CLI v1.1.15
- Enhance generate-cli-docs.js to handle "Subcommands:" and "Help topics:" sections - Skip help topic sections as they are not real commands - Fix alias marker stripping from command descriptions - Improve indentation detection for command entries - Regenerate all CLI command documentation - Update cloud-js-sdk reference documentation
Add five new pages under phala-cloud/key-management covering the full onchain KMS lifecycle: understanding the model, first deployment, updating compose, device allowlist management, and multisig/governance flows. Update cloud-vs-onchain-kms.mdx with revised content and remove the now-superseded on-chain-kms-guide from the JS SDK reference.
Extract hands-on replication steps into a new replicating-cvms.mdx covering dashboard, CLI, Onchain KMS auto-registration, multisig prepare/commit, and API reference. Trim multi-replica-scaling.mdx to a pure concept and decision page that links to the new guide.
Normalize "Cloud UI" / "Dashboard UI" to "dashboard" across cvm and env-var pages. Refresh cvm/overview.mdx with concise option descriptions and links to the new replicating-cvms guide. Update commit token validity from 7 to 14 days in deploy.mdx. Redirect provision-cvm SDK reference from the deleted on-chain-kms-guide to deploying-with-onchain-kms.
Leechael
changed the title
Point SOURCE_FILE to ../../docs/error-codes.md (relative to the docs repo root inside the teehouse monorepo submodule layout) instead of the old phala-cloud-monorepo path. Replace BSD-incompatible multi-command sed range with portable awk.
error-codes.mdx: - Add missing ERR-03-003 (CvmNotInWorkspaceError, reveal mode, HTTP 404) and ERR-03-004 (same class, security mode — masks as not-found, HTTP 404) - Add HTTP 404/409 annotations for non-standard Module 03 error codes - Add Module 05 to module list (was missing) - Add Module 06 note (OAuth redirect errors, not JSON API responses) - Restore full descriptions for ERR-01-005 through ERR-01-008 cloud-js-sdk/error-handling.mdx: - Fix formatStructuredError example: ERR-01-001 → ERR-02-001 (ERR-01-001 is NodeNotFoundError, not InstanceTypeNotFoundError) cloud-python-sdk/error-handling.mdx: - Clarify Module 06 table entry: returned as OAuth redirects, not JSON
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
on-chain-kms-guidein the JS SDK referencereplicating-cvms.mdxwith dashboard, CLI, auto-registration, and multisig prepare/commit flows;multi-replica-scaling.mdxtrimmed to a concept/decision page