From a1e66784a82ff3506b0b78e5853dfcecac25f5e6 Mon Sep 17 00:00:00 2001 From: Amar Tumballi Date: Tue, 5 Dec 2023 12:14:45 +0530 Subject: [PATCH] doc builder updates and readme update backport of #153 and #152 --- README.md | 6 ++---- packages/did/src/index.ts | 4 ---- tsconfig.docs.json | 10 +++++++--- 3 files changed, 9 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 92c21d9b..f63f2f0f 100644 --- a/README.md +++ b/README.md @@ -46,11 +46,9 @@ Follow the instructions under the topic - "Run the node" ``` -$ yarn demo +$ npx tsx demo/src/func-test.ts -$ yarn demo-vc - -$ yarn bench +$ npx tsx demo/src/network-score-test.ts ``` The output of these runs are self-explanatory. For reference of how this is structured, diff --git a/packages/did/src/index.ts b/packages/did/src/index.ts index 58ec5fb2..477400f6 100644 --- a/packages/did/src/index.ts +++ b/packages/did/src/index.ts @@ -1,7 +1,3 @@ -/** - * @module @@cord.network/did - */ - export * from './DidDetails/index.js' export * from './DidDocumentExporter/index.js' export * from './DidResolver/index.js' diff --git a/tsconfig.docs.json b/tsconfig.docs.json index 4b7da8e8..f88a66b4 100644 --- a/tsconfig.docs.json +++ b/tsconfig.docs.json @@ -20,9 +20,11 @@ "packages/statement/src/index.ts", "packages/identifier/src/index.ts", "packages/chain-space/src/index.ts", + "packages/schema/src/index.ts", + "packages/network-score/src/index.ts", "packages/sdk/src/index.ts" ], - "out": "docs/api", + "out": "docs", "theme": "default", "exclude": [ "**/*spec.ts", @@ -37,11 +39,13 @@ "hideGenerator": true, "excludeInternal": true, "categorizeByGroup": true, - "name": "CORD.js Documentation", + "excludeNotDocumented": true, + "includeVersion": true, + "name": "SDK Documentation", "readme": "README.md", "navigation": { "includeCategories": true, - "includeGroups": true + "includeGroups": true, }, } }