Unify API folder structure

iotaledger · Sep 22, 2023 · 7a31a00 · 7a31a00
1 parent a42af5b
commit 7a31a00
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 17 deletions.
diff --git a/docs/build/.gitignore b/docs/build/.gitignore
diff --git a/docs/build/apis/.gitignore b/docs/build/apis/.gitignore
@@ -0,0 +1,2 @@
+docs/*
+!docs/welcome.md
diff --git a/docs/build/apis/welcome.md → docs/build/apis/docs/welcome.md b/docs/build/apis/welcome.md → docs/build/apis/docs/welcome.md
diff --git a/docs/build/apis/sidebars.ts → docs/build/apis/sidebars.js b/docs/build/apis/sidebars.ts → docs/build/apis/sidebars.js
@@ -17,45 +17,45 @@ module.exports = {
           type: 'category',
           label: 'V1',
           collapsed: true,
-          items: require('./core/v1/sidebar'),
+          items: require('./docs/core/v1/sidebar'),
         },
         {
           type: 'category',
           label: 'V2',
           collapsed: true,
-          items: require('./core/v2/sidebar'),
+          items: require('./docs/core/v2/sidebar'),
         },
       ],
     },
     {
       type: 'category',
       label: 'Wasp',
       collapsed: true,
-      items: require('./wasp/sidebar'),
+      items: require('./docs/wasp/sidebar'),
     },
     {
       type: 'category',
       label: 'Explorer',
       collapsed: true,
-      items: require('./explorer/sidebar'),
+      items: require('./docs/explorer/sidebar'),
     },
     {
       type: 'category',
       label: 'Indexer',
       collapsed: true,
-      items: require('./indexer/sidebar'),
+      items: require('./docs/indexer/sidebar'),
     },
     {
       type: 'category',
       label: 'IRC Metadata',
       collapsed: true,
-      items: require('./irc-metadata/sidebar'),
+      items: require('./docs/irc-metadata/sidebar'),
     },
     {
       type: 'category',
       label: 'PoI',
       collapsed: true,
-      items: require('./poi/sidebar'),
+      items: require('./docs/poi/sidebar'),
     },
   ],
 };
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -173,47 +173,47 @@ module.exports = async () => {
               coreApiChrysalis: {
                 specPath:
                   'https://raw.githubusercontent.com/iotaledger/tips/main/tips/TIP-0013/rest-api.yaml',
-                outputDir: path.resolve(__dirname, 'docs/build/apis/core/v1'),
+                outputDir: path.resolve(__dirname, 'docs/build/apis/docs/core/v1'),
                 sidebarOptions: {
                   groupPathsBy: 'tag',
                 },
               },
               coreApiShimmer: {
                 specPath:
                   'https://raw.githubusercontent.com/iotaledger/tips/main/tips/TIP-0025/core-rest-api.yaml',
-                outputDir: path.resolve(__dirname, 'docs/build/apis/core/v2'),
+                outputDir: path.resolve(__dirname, 'docs/build/apis/docs/core/v2'),
                 sidebarOptions: {
                   groupPathsBy: 'tag',
                 },
               },
               waspApi: {
                 specPath:
                   'https://raw.githubusercontent.com/iotaledger/wasp/develop/clients/apiclient/api/openapi.yaml',
-                outputDir: path.resolve(__dirname, 'docs/build/apis/wasp'),
+                outputDir: path.resolve(__dirname, 'docs/build/apis/docs/wasp'),
                 sidebarOptions: {
                   groupPathsBy: 'tag',
                 },
               },
               indexerApi: {
                 specPath:
                   'https://raw.githubusercontent.com/iotaledger/tips/main/tips/TIP-0026/indexer-rest-api.yaml',
-                outputDir: path.resolve(__dirname, 'docs/build/apis/indexer'),
+                outputDir: path.resolve(__dirname, 'docs/build/apis/docs/indexer'),
                 sidebarOptions: {
                   groupPathsBy: 'tag',
                 },
               },
               poiApi: {
                 specPath:
                   'https://raw.githubusercontent.com/iotaledger/inx-poi/develop/rest-api.yaml',
-                outputDir: path.resolve(__dirname, 'docs/build/apis/poi'),
+                outputDir: path.resolve(__dirname, 'docs/build/apis/docs/poi'),
                 sidebarOptions: {
                   groupPathsBy: 'tag',
                 },
               },
               explorerApi: {
                 specPath:
                   'https://raw.githubusercontent.com/iotaledger/inx-chronicle/main/documentation/api/api-explorer.yml',
-                outputDir: path.resolve(__dirname, 'docs/build/apis/explorer'),
+                outputDir: path.resolve(__dirname, 'docs/build/apis/docs/explorer'),
                 sidebarOptions: {
                   groupPathsBy: 'tag',
                 },
@@ -223,7 +223,7 @@ module.exports = async () => {
                   'https://raw.githubusercontent.com/iotaledger/inx-irc-metadata/develop/rest-api.yaml',
                 outputDir: path.resolve(
                   __dirname,
-                  'docs/build/apis/irc-metadata',
+                  'docs/build/apis/docs/irc-metadata',
                 ),
                 sidebarOptions: {
                   groupPathsBy: 'tag',