docs: align developer portal with Hardware SDK 1.2.0 - #920
Conversation
Add a first-run Getting Started path, Protocol V2 / Pro2 / Neo concepts, and the public 1.2.0 APIs that were missing from the portal. Refresh the changelog, device matrix, and iframe version so the 1.2.0 line is tellable.
Move common params and HD paths to a dedicated reference. Keep the Core API Guide as the lifecycle/events path. Add firmware-update and reconnect how-tos, a transport chooser, and 1.2.0 identifier wording.
Sync changelog from GitHub releases, stop hardcoding iframe connectSrc, add Pro 2 / Neo device icons, document TON signing_message and Solana off-chain signing, and switch Getting Started to getDeviceState.
Stop teaching preloadSessionCache/session_id persistence and keepSession in signer and passphrase pages. Omit hardcoded iframe hosts in migration guides and use getDeviceState in lifecycle samples.
|
@codex review |
|
@codex security review |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
|
Security review completed. No security issues were found in this pull request. Reviewed commit: Only the user who started this review can view the report in Codex. ℹ️ About Codex security reviews in GitHubThis is an experimental Codex feature. Security reviews are triggered when:
Once complete, Codex will leave suggestions, or a comment if no findings are found. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: feb7952426
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
keepSession is a transport hold, not a wallet-session replacement. Drop resume-hidden from the 1.2.0 changelog, mark getFeatures as V1-only, and align the RN/Android demos with the public 1.2.x contract.
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
3 participants
Summary
Draft for reviewing how Hardware SDK 1.2.0 developer docs should work, plus the portal content so that story is actually tellable.
The public portal still described a 1.1-era SDK: changelog stopped at
v1.1.21, iframeconnectSrcpointed at1.1.19, Pro 2 / Neo were missing, and Protocol V2 / wallet sessions /firmwareUpdateV4only existed in internaldocs/.This PR:
packages/connect-examples/developer-portal/docs/1.2.0-information-architecture.mdopenWalletSession,getDeviceState, andfirmwareUpdateV4connectSrcsogetSDKVersion()fillshttps://jssdk.onekey.so/<installed>/searchDevices{ success, payload }, persistdeviceId + passphraseState, no firmwaresession_id)hd-web-sdkomitsconnectSrcCommonParams.keepSession@deprecated(useuseEmptyPassphraseoropenWalletSession+passphraseState)docs/vs package READMEIntent and context
1.2.0 is the first stable Hardware SDK that speaks Protocol V2 (Pro 2, Neo) while keeping Protocol V1 (Classic / Mini / Touch / Pro). The JavaScript API did not become a second SDK. The portal needs to teach that fact, then send people down transport / PIN / signing / chain-support paths.
Internal
docs/remains the mechanism source. The portal only publishes the public contract.Root cause
Public docs were not updated when the 1.2.0 Protocol V2 line shipped. New integrator-visible APIs and devices never got portal pages, and stale 1.1 versions stayed in examples.
Design decisions
getSupportedProtocols()plusdocs/device/capabilities.mdcaveats. Integrators do not callgetSupportedProtocols(); they use this page plus liveconnectProtocol.lnurlAuthandevmSignMessageEIP712are extra V1-only methods.session_idstore, probe order, host binding) into the portal.keepSessiondeprecation ship in this PR so npm and the portal say the same thing. No runtime change.Compatibility and risk
Documentation and a public TypeScript
@deprecatedonkeepSession. ExistingkeepSession: truecalls still work. Transportrelease(..., keepSession)is unchanged.Hardware coverage
Not applicable. No device protocol or firmware change.
Test plan
yarn agent:check --profile commit(agent context, whitespace, changed-file lint) for portal commitsyarn dev:docsand click Landing → Getting Started → Devices / Protocol / Wallet Sessions / Chain Support in EN and ZHhd-web-sdkversion (omitconnectSrc)yarn agent:check --profile prskipped: no package runtime changeOut of this track
mintables (they go stale)Preview locally from the worktree:
yarn dev:docs.