docs: updates documentation to use sdk folder

Signed-off-by: Allain Magyar <allain.magyar@iohk.io>
input-output-hk · May 8, 2024 · e7ce917 · e7ce917
1 parent 4e90062
commit e7ce917
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 9 deletions.
diff --git a/docs/README.mdx b/docs/README.mdx
@@ -0,0 +1,5 @@
+<head>
+  <meta http-equiv='refresh' content='0; URL=/atala-prism-wallet-sdk-ts/sdk/'/>
+</head>
+
+Redirecting to `/atala-prism-wallet-sdk-ts/sdk/`.
diff --git a/docs/README.md → docs/sdk/README.md b/docs/README.md → docs/sdk/README.md
@@ -1,3 +1,5 @@
+@atala/prism-wallet-sdk / [Exports](modules.md)
+
 # Identus TypeScript SDK
 
 [![Coverage Status](https://coveralls.io/repos/github/input-output-hk/atala-prism-wallet-sdk-ts/badge.svg?branch=master)](https://coveralls.io/github/input-output-hk/atala-prism-wallet-sdk-ts?branch=master)
@@ -102,5 +104,4 @@ This SDK exposes Pluto, a storage interface that should be implemented by the us
 
 We don't provide a default implementation out of the box at the moment, but we do provide a couple of demo implementations that can be used to get started with demos and testing. 
 
-Provided demo implementations are intentionally oversimplified and SHOULD NOT be used in production. 
-
+Provided demo implementations are intentionally oversimplified and SHOULD NOT be used in production.
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -7,7 +7,7 @@ const sidebars = {
         {
             label: 'Introduction',
             type: "doc",
-            id: "README"
+            id: "sdk/README"
         },
         {
             type: 'category',
@@ -59,9 +59,8 @@ const sidebars = {
                                     ...files.map((filename) => {
 
                                         const fixFile = `sdk/${currentFolder}/${filename.replace(".md", "")}`
-                                        console.log(fixFile)
                                         return {
-                                            label: fixFile.replace(`${currentFolder}/Domain.`, ""),
+                                            label: fixFile.replace(`sdk/${currentFolder}/Domain.`, ""),
                                             type: "doc",
                                             id: fixFile
                                         }
@@ -94,7 +93,7 @@ const sidebars = {
                                     ...files.map((filename) => {
                                         const fixFile = `sdk/${currentFolder}/${filename.replace(".md", "")}`
                                         return {
-                                            label: fixFile.replace(`${currentFolder}/`, ""),
+                                            label: fixFile.replace(`sdk/${currentFolder}/`, ""),
                                             type: "doc",
                                             id: fixFile
                                         }

diff --git a/package.json b/package.json
@@ -38,9 +38,7 @@
     "test": "jest",
     "coverage": "npm run test -- --coverage",
     "lint": "npx eslint .",
-    "docs": "npm run docs:readme; npm run docs:typedoc",
-    "docs:typedoc": "npx typedoc --options typedoc.js --hideGenerator",
-    "docs:readme": "cp README.md docs/README.md"
+    "docs": "npx typedoc --options typedoc.js"
   },
   "author": "IOHK",
   "repository": {