📈 (repo) [DSDK-368]: Add backstage metadata (#558)

LedgerHQ · Jan 10, 2025 · 019e9b8 · 019e9b8
2 parents dd51763 + 72e7b0e
commit 019e9b8
Show file tree

Hide file tree

Showing 31 changed files with 2,109 additions and 1,098 deletions.
diff --git a/apps/docs/eslint.config.mjs b/apps/docs/eslint.config.mjs
@@ -4,7 +4,7 @@ import globals from "globals";
 export default [
   ...baseConfig,
   {
-    ignores: [".next"],
+    ignores: [".next", "**/_meta.js"],
   },
   {
     languageOptions: {
@@ -15,7 +15,7 @@ export default [
   },
   {
     files: [
-      "next.config.js",
+      "next.config.mjs",
       "postcss.config.js",
       "tailwind.config.js",
       "theme.config.tsx",

diff --git a/apps/docs/next.config.js b/apps/docs/next.config.js
diff --git a/apps/docs/next.config.mjs b/apps/docs/next.config.mjs
@@ -0,0 +1,8 @@
+import nextra from "nextra";
+
+const withNextra = nextra({
+  theme: "nextra-theme-docs",
+  themeConfig: "./theme.config.tsx",
+});
+
+export default withNextra();
diff --git a/apps/docs/package.json b/apps/docs/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@ledgerhq/ledger-dmk-docs",
   "version": "1.0.0",
-  "description": "",
+  "description": "Device Management Kit documentation",
   "private": true,
   "scripts": {
     "dev": "next dev",
@@ -19,14 +19,16 @@
   "dependencies": {
     "autoprefixer": "^10.4.17",
     "next": "^14.2.15",
-    "nextra": "^2.13.3",
-    "nextra-theme-docs": "^2.13.3",
-    "postcss": "^8.4.35",
+    "nextra": "^3.0.13",
+    "nextra-theme-blog": "^3.0.13",
+    "nextra-theme-docs": "^3.0.15",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
-    "tailwindcss": "^3.4.16"
+    "tailwindcss": "^3.4.16",
+    "tailwind-merge": "^1.14.0"
   },
   "devDependencies": {
+    "autoprefixer": "^10.4.17",
     "@ledgerhq/eslint-config-dsdk": "workspace:*",
     "@ledgerhq/prettier-config-dsdk": "workspace:*",
     "@ledgerhq/tsconfig-dsdk": "workspace:*",

diff --git a/apps/docs/pages/_app.mdx → apps/docs/pages/_app.js b/apps/docs/pages/_app.mdx → apps/docs/pages/_app.js
diff --git a/apps/docs/pages/_meta.js b/apps/docs/pages/_meta.js
@@ -0,0 +1,13 @@
+export default {
+  index: {
+    title: "Home",
+    theme: {
+      layout: "raw",
+    },
+    display: "hidden",
+  },
+  docs: {
+    title: "Documentation",
+    type: "page",
+  },
+};
diff --git a/apps/docs/pages/_meta.json b/apps/docs/pages/_meta.json
diff --git a/apps/docs/pages/docs/_meta.js b/apps/docs/pages/docs/_meta.js
@@ -0,0 +1,8 @@
+export default {
+  docs: "Ledger Device Management Kits",
+  explanations: "Explanations",
+  beginners: "Beginner's guide",
+  integration_walkthroughs: "Integration Walkthrough",
+  migrations: "Migrations",
+  references: "References (TSDoc)",
+};
diff --git a/apps/docs/pages/docs/_meta.json b/apps/docs/pages/docs/_meta.json
diff --git a/apps/docs/pages/docs/beginners/_meta.js b/apps/docs/pages/docs/beginners/_meta.js
@@ -0,0 +1,6 @@
+export default {
+  setup: "Setup",
+  init_dmk: "Initialize Device Management Kit",
+  discover_and_connect: "Discover and connect",
+  exchange_data: "Exchange data with the device",
+};
diff --git a/apps/docs/pages/docs/beginners/_meta.json b/apps/docs/pages/docs/beginners/_meta.json
diff --git a/apps/docs/pages/docs/explanations/_meta.js b/apps/docs/pages/docs/explanations/_meta.js
@@ -0,0 +1,6 @@
+export default {
+  introduction: "Why the Device Management Kit?",
+  ledgerjs: "Differences with LedgerJS",
+  dmk: "Device Management Kit",
+  signers: "Signer kits",
+};
diff --git a/apps/docs/pages/docs/explanations/_meta.json b/apps/docs/pages/docs/explanations/_meta.json
diff --git a/apps/docs/pages/docs/explanations/signers/_meta.js b/apps/docs/pages/docs/explanations/signers/_meta.js
@@ -0,0 +1,5 @@
+export default {
+  eth: "Signer Ethereum (EVM)",
+  solana: "Signer Solana",
+  btc: "Signer Bitcoin",
+};
diff --git a/apps/docs/pages/docs/explanations/signers/_meta.json b/apps/docs/pages/docs/explanations/signers/_meta.json
diff --git a/apps/docs/pages/docs/integration_walkthroughs/_meta.js b/apps/docs/pages/docs/integration_walkthroughs/_meta.js
@@ -0,0 +1,3 @@
+export default {
+  how_to: "How to ...",
+};
diff --git a/apps/docs/pages/docs/integration_walkthroughs/_meta.json b/apps/docs/pages/docs/integration_walkthroughs/_meta.json
diff --git a/apps/docs/pages/docs/integration_walkthroughs/how_to/_meta.js b/apps/docs/pages/docs/integration_walkthroughs/how_to/_meta.js
@@ -0,0 +1,4 @@
+export default {
+  how_to_use_a_signer: "use a Signer",
+  build_custom_command: "build a custom command",
+};
diff --git a/apps/docs/pages/docs/integration_walkthroughs/how_to/_meta.json b/apps/docs/pages/docs/integration_walkthroughs/how_to/_meta.json
diff --git a/apps/docs/pages/docs/migrations/_meta.js b/apps/docs/pages/docs/migrations/_meta.js
@@ -0,0 +1,3 @@
+export default {
+  "04_to_05": "DMK: Migrate from v0.4.0 to 0.5.0",
+};
diff --git a/apps/docs/pages/docs/migrations/_meta.json b/apps/docs/pages/docs/migrations/_meta.json
diff --git a/apps/docs/tsconfig.eslint.json b/apps/docs/tsconfig.eslint.json
@@ -1,10 +1,11 @@
 {
   "extends": "./tsconfig.json",
   "include": [
+    "**/*.js",
     "**/*.ts",
     "**/*.tsx",
     ".next/types/**/*.ts",
-    "next.config.js",
+    "next.config.mjs",
     "postcss.config.js",
     "eslint.config.mjs",
     "tailwind.config.js"

diff --git a/apps/docs/tsconfig.json b/apps/docs/tsconfig.json
@@ -12,7 +12,9 @@
     "next-env.d.ts",
     "**/*.ts",
     "**/*.tsx",
+    "**/*.js",
     "eslint.config.mjs",
+    "pages/_app.js",
     "tailwind.config.js"
   ],
   "exclude": ["node_modules"]

diff --git a/apps/sample/public/devices.png b/apps/sample/public/devices.png
diff --git a/apps/sample/public/devices_crop.png b/apps/sample/public/devices_crop.png
diff --git a/apps/sample/public/favicon.png b/apps/sample/public/favicon.png
diff --git a/apps/sample/public/nano-x.png b/apps/sample/public/nano-x.png
diff --git a/apps/sample/src/app/client-layout.tsx b/apps/sample/src/app/client-layout.tsx
@@ -44,6 +44,9 @@ const ClientRootLayout: React.FC<PropsWithChildren> = ({ children }) => {
             <SignerEthProvider>
               <StyleProvider selectedPalette="dark" fontsPath="/fonts">
                 <GlobalStyle />
+                <head>
+                  <link rel="shortcut icon" href="../favicon.png" />
+                </head>
                 <body>
                   <Root>
                     <Sidebar />

diff --git a/apps/sample/src/components/MainView/index.tsx b/apps/sample/src/components/MainView/index.tsx
@@ -6,7 +6,7 @@ import styled, { type DefaultTheme } from "styled-components";
 
 import { ConnectDeviceActions } from "./ConnectDeviceActions";
 
-const Root = styled(Flex)`
+const Root = styled(Flex).attrs({ rowGap: 6 })`
   flex: 1;
   justify-content: center;
   align-items: center;
@@ -18,14 +18,10 @@ const ErrorNotification = styled(Notification)`
   width: 70%;
 `;
 
-const Description = styled(Text).attrs({ my: 6 })`
+const Description = styled(Text)`
   color: ${({ theme }: { theme: DefaultTheme }) => theme.colors.neutral.c70};
 `;
 
-const NanoLogo = styled(Image).attrs({ mb: 8 })`
-  transform: rotate(23deg);
-`;
-
 export const MainView: React.FC = () => {
   const [connectionError, setConnectionError] = useState<DmkError | null>(null);
 
@@ -44,11 +40,11 @@ export const MainView: React.FC = () => {
   }, [connectionError]);
   return (
     <Root>
-      <NanoLogo
-        src={"/nano-x.png"}
-        alt={"nano-x-logo"}
-        width={155}
-        height={250}
+      <Image
+        src={"/devices_crop.png"}
+        alt={"ledger-devices-image"}
+        width={400}
+        height={330}
       />
       <Text variant={"h2Inter"} fontWeight={"semiBold"} textTransform={"none"}>
         Ledger Device Management Kit

diff --git a/catalog-info.yml b/catalog-info.yml
@@ -0,0 +1,102 @@
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: device-management-kit-ts
+  description: Device Management Kit Library
+  tags:
+    - typescript
+    - sdk
+    - device-management-kit
+  annotations:
+    #backstage.io/techdocs-ref: dir:.
+    #backstage.io/adr-location: docs/architecture/decisions
+    github.com/project-slug: "LedgerHQ/device-sdk-ts"
+    github.com/team-slug: "LedgerHQ/live-devices"
+    ledger.com/code_repository: https://github.com/LedgerHQ/device-sdk-ts
+    ledger.com/documentation: https://developers.ledger.com/docs/device-interaction/getting-started
+    jira/project-key: DSDK
+  labels:
+    ledger.com/contains_pii: "no"
+    ledger.com/donjon_review: "on-demand"
+    license: Apache-2.0
+spec:
+  type: library
+  lifecycle: production
+  owner: group:live-devices
+  system: ledger-device-management-kit
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: ts-device-management-kit
+  description: Device Management Kit Library
+  tags:
+    - typescript
+    - library
+    - device-management-kit
+    - npm
+spec:
+  type: library
+  lifecycle: production
+  owner: group:live-devices
+  system: ledger-device-management-kit
+  subComponentOf: device-management-kit-ts
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: ts-device-signer-kit-ethereum
+  description: Signer Kit for ETH
+spec:
+  type: library
+  lifecycle: production
+  owner: group:live-devices
+  system: ledger-device-management-kit
+  subComponentOf: ts-device-management-kit
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: ts-device-signer-kit-ethereum
+  description: Signer Kit for ETH
+spec:
+  type: library
+  lifecycle: production
+  owner: group:live-devices
+  system: ledger-device-management-kit
+  subComponentOf: ts-device-management-kit
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: ts-device-signer-kit-solana
+  description: Signer Kit for Solana
+  tags:
+    - typescript
+    - signer
+    - solana
+    - npm
+spec:
+  type: library
+  lifecycle: production
+  owner: group:live-devices
+  system: ledger-device-management-kit
+  subComponentOf: device-management-kit-ts
+---
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: ts-context-module
+  description: Module for adding context to transactions
+  tags:
+    - typescript
+    - cal-service
+    - clear-signing
+    - npm
+spec:
+  type: library
+  lifecycle: production
+  owner: group:live-devices
+  system: ledger-device-management-kit
+  subComponentOf: device-management-kit-ts