From 1a34fedbe7d8514d9febd5edbf1a8f499b165b9a Mon Sep 17 00:00:00 2001 From: "Valentin D. Pinkman" Date: Mon, 27 Jan 2025 14:15:53 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20(doc):=20Add=20missing=20=5Fmeta?= =?UTF-8?q?.js=20file?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../docs/explanations/transports/transports.mdx | 14 +++++--------- apps/docs/pages/docs/migrations/_meta.js | 4 ++++ apps/docs/pages/docs/migrations/dmk/_meta.js | 2 +- .../docs/pages/docs/migrations/signer-eth/_meta.js | 3 --- apps/docs/pages/docs/migrations/signers/_meta.js | 3 +++ .../{signer-eth => signers/eth}/1_1_0_to_1_2_0.mdx | 0 .../pages/docs/migrations/signers/eth/_meta.js | 3 +++ 7 files changed, 16 insertions(+), 13 deletions(-) create mode 100644 apps/docs/pages/docs/migrations/_meta.js delete mode 100644 apps/docs/pages/docs/migrations/signer-eth/_meta.js create mode 100644 apps/docs/pages/docs/migrations/signers/_meta.js rename apps/docs/pages/docs/migrations/{signer-eth => signers/eth}/1_1_0_to_1_2_0.mdx (100%) create mode 100644 apps/docs/pages/docs/migrations/signers/eth/_meta.js diff --git a/apps/docs/pages/docs/explanations/transports/transports.mdx b/apps/docs/pages/docs/explanations/transports/transports.mdx index f183b024a..b29d5c74b 100644 --- a/apps/docs/pages/docs/explanations/transports/transports.mdx +++ b/apps/docs/pages/docs/explanations/transports/transports.mdx @@ -5,18 +5,14 @@ Depending on the environment and usecase, you can choose the transport that best ## Available transports -| Transport | Description | -| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- | -| [WebHid](https://www.npmjs.com/package/@ledgerhq/device-transport-kit-web-hid) | The WebHID transport is a transport that uses the WebHID API (usb) to communicate with a Ledger device. | -| [WebBle](https://www.npmjs.com/package/@ledgerhq/device-transport-kit-web-ble) | The WebBLE transport is a transport that uses the WebBLE API (bluetooth) to communicate with a Ledger device. | - -### WebBLE - -The WebBLE transport is a transport that uses the WebBLE API (bluetooth) to communicate with a Ledger device. +| Transport | Description | +| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | +| [WebHid](https://www.npmjs.com/package/@ledgerhq/device-transport-kit-web-hid) | The WebHID transport uses the Web HID API (usb) to communicate with a Ledger device. | +| [WebBle](https://www.npmjs.com/package/@ledgerhq/device-transport-kit-web-ble) | The WebBLE transport uses the Web BLE API (bluetooth) to communicate with a Ledger device. | ## How to use a transport -Transports are injected in the DeviceManagementKitBuilder before building the DeviceManagementKit instance. +Transports are injected in the DeviceManagementKitBuilder before building the Device Management Kit instance. This is done by calling the `addTransport` method on the builder. You can inject the transport in two different ways: diff --git a/apps/docs/pages/docs/migrations/_meta.js b/apps/docs/pages/docs/migrations/_meta.js new file mode 100644 index 000000000..f4cf5b012 --- /dev/null +++ b/apps/docs/pages/docs/migrations/_meta.js @@ -0,0 +1,4 @@ +export default { + dmk: "Device Management Kit", + signers: "Device Signer Kits", +}; diff --git a/apps/docs/pages/docs/migrations/dmk/_meta.js b/apps/docs/pages/docs/migrations/dmk/_meta.js index 7639a4de8..a37e84f19 100644 --- a/apps/docs/pages/docs/migrations/dmk/_meta.js +++ b/apps/docs/pages/docs/migrations/dmk/_meta.js @@ -1,3 +1,3 @@ export default { - "05_to_06": "DMK: Migrate from v0.5.0 to 0.6.0", + "05_to_06": "v0.5.0 -> 0.6.0", }; diff --git a/apps/docs/pages/docs/migrations/signer-eth/_meta.js b/apps/docs/pages/docs/migrations/signer-eth/_meta.js deleted file mode 100644 index e5947ffa5..000000000 --- a/apps/docs/pages/docs/migrations/signer-eth/_meta.js +++ /dev/null @@ -1,3 +0,0 @@ -export default { - "1_1_0_to_1_2_0": "Signer ETH: Migrate from v1.1.0 to 1.2.0", -}; diff --git a/apps/docs/pages/docs/migrations/signers/_meta.js b/apps/docs/pages/docs/migrations/signers/_meta.js new file mode 100644 index 000000000..6882dc776 --- /dev/null +++ b/apps/docs/pages/docs/migrations/signers/_meta.js @@ -0,0 +1,3 @@ +export default { + eth: "Ethereum", +}; diff --git a/apps/docs/pages/docs/migrations/signer-eth/1_1_0_to_1_2_0.mdx b/apps/docs/pages/docs/migrations/signers/eth/1_1_0_to_1_2_0.mdx similarity index 100% rename from apps/docs/pages/docs/migrations/signer-eth/1_1_0_to_1_2_0.mdx rename to apps/docs/pages/docs/migrations/signers/eth/1_1_0_to_1_2_0.mdx diff --git a/apps/docs/pages/docs/migrations/signers/eth/_meta.js b/apps/docs/pages/docs/migrations/signers/eth/_meta.js new file mode 100644 index 000000000..0a3ca5f19 --- /dev/null +++ b/apps/docs/pages/docs/migrations/signers/eth/_meta.js @@ -0,0 +1,3 @@ +export default { + "1_1_0_to_1_2_0": "v1.1.0 -> 1.2.0", +};