Skip to content

docs: align package names and document Ledger connector interfaces#795

Draft
cursor[bot] wants to merge 1 commit into
onekeyfrom
cursor/technical-documentation-updates-6d7f
Draft

docs: align package names and document Ledger connector interfaces#795
cursor[bot] wants to merge 1 commit into
onekeyfrom
cursor/technical-documentation-updates-6d7f

Conversation

@cursor
Copy link
Copy Markdown

@cursor cursor Bot commented May 18, 2026

Summary

  • align top-level package names and paths with the current workspace package manifests
  • document the HWK Ledger connector packages and shared IConnector workflow in docs/architecture.md
  • refresh packages/hd-transport-web-device/README.md so its package name, exports, and local dev command match the source

Docs updated

  • README.md
  • docs/architecture.md
  • packages/hd-transport-web-device/README.md

Codepaths covered

  • packages/core/package.json
  • packages/hd-transport-web-device/package.json
  • packages/hd-transport-web-device/src/index.ts
  • packages/hd-transport-web-device/src/webusb.ts
  • packages/hd-transport-web-device/src/electron-ble-transport.ts
  • packages/hwk-adapter-core/src/types/connector.ts
  • packages/hwk-ledger-connector-webhid/src/index.ts
  • packages/hwk-ledger-connector-ble/src/index.ts

Knowledge gaps addressed

  • outdated @onekeyfe/core / @onekeyfe/hd-transport-webusb package references in top-level docs
  • missing overview of the recently active HWK Ledger connector packages and their public connector interface
  • missing package-level usage notes for @onekeyfe/hd-transport-web-device

Validation

  • source-checked package names, exports, connector methods, and runtime constraints against the repository files above
Open in Web View Automation 

Co-authored-by: Leon <lixiao.dev@gmail.com>
@revan-zhang
Copy link
Copy Markdown
Contributor

revan-zhang commented May 18, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants