doc builder updates and readme update (#154)

backport of #153 and #152
dhiway · Dec 6, 2023 · bc357eb · bc357eb
1 parent b7b5364
commit bc357eb
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 11 deletions.
diff --git 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
@@ -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
@@ -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,
     },
   }
 }