move api reference link to avoid clutter (#83)

cosmos · Nov 15, 2023 · a60da94 · a60da94
1 parent dc064db
commit a60da94
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 15 deletions.
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -61,19 +61,19 @@ const config = {
       }),
     ],
     [
-      'redocusaurus',
+      "redocusaurus",
       {
         // Plugin Options for loading OpenAPI files
         specs: [
           {
-            spec: 'openapi/swagger.yaml',
-            route: '/api/',
+            spec: "openapi/swagger.yaml",
+            route: "/api/",
           },
         ],
         // Theme Options for modifying how redoc renders them
         theme: {
           // Change with your site colors
-          primaryColor: '#1890ff',
+          primaryColor: "#1890ff",
         },
       },
     ],
@@ -105,23 +105,27 @@ const config = {
             position: "left",
           },
           {
-            type: "doc",
-            label: "Build",
-            docId: "build/building-modules/intro",
-            position: "left",
+            type: 'dropdown',
+            label: 'Build',
+            position: 'left',
+            items: [
+              {
+                type: "doc",
+                label: "Build a Module",
+                docId: "build/building-modules/intro",
+              },
+              {
+                label: "Cosmos SDK API",
+                to: "api",
+              },
+            ],
           },
           {
             type: "doc",
             label: "User Guides",
             docId: "user/run-node/keyring", // I find it weird that it points to the keyring and not a common page
             position: "left",
           },
-          {
-            label: "API Reference",
-            page: "api", // I find it weird that it points to the keyring and not a common page
-            position: "left",
-            to: "api"
-          },
           {
             href: "https://github.com/cosmos/cosmos-sdk",
             html: `<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg" class="github-icon">
@@ -173,6 +177,10 @@ const config = {
                 label: "IBC Go",
                 href: "https://ibc.cosmos.network",
               },
+              {
+                label: "Cosmos SDK API",
+                to: "api",
+              },
             ],
           },
           {

diff --git a/openapi/swagger.yaml b/openapi/swagger.yaml
@@ -1,7 +1,7 @@
 swagger: '2.0'
 info:
   title: Cosmos SDK - gRPC Gateway docs
-  description: A REST interface for state queries.
+  description: A REST interface for state queries. This API document is updated with the latest changes. Previous version APIs will be best viewed by checking a node directly
   version: 1.0.0
 paths:
   /cosmos/auth/v1beta1/account_info/{address}: