Fix broken docs; Tidy up hexy api sidebar

BenBowers · Mar 14, 2024 · 75e4a7c · 75e4a7c
1 parent b2a49d6
commit 75e4a7c
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 5 deletions.
diff --git a/backend/infra/api-definition.ts b/backend/infra/api-definition.ts
@@ -82,6 +82,7 @@ export const generateApiSpec = ({
   paths: {
     '/borrower': {
       post: {
+        tags: ['Borrower'],
         summary: 'Create a borrower',
         requestBody: {
           required: true,
@@ -159,6 +160,7 @@ export const generateApiSpec = ({
     },
     '/borrowingCapacity': {
       get: {
+        tags: ['Borrowing Capacity'],
         summary: 'Get an estimate of your borrowing capacity',
         parameters: [
           {
@@ -256,6 +258,7 @@ export const generateApiSpec = ({
     },
     '/loan': {
       post: {
+        tags: ['Loan Application'],
         summary: 'Apply for a loan',
         requestBody: {
           required: true,

diff --git a/docs/docs/borrower-profile/explore-api.mdx b/docs/docs/borrower-profile/explore-api.mdx
@@ -9,7 +9,7 @@ tags:
 1. In your browser, navigate to the `Create a Borrower` API documentation:
 
     ```text
-    http://localhost:3000/docs/hexy/create-a-borrower
+    http://localhost:3000/hexyback-workshop/docs/hexy/create-a-borrower
     ```
 
 2. Modify the sample request body:

diff --git a/docs/docs/borrowing-capacity/explore-api.mdx b/docs/docs/borrowing-capacity/explore-api.mdx
@@ -9,7 +9,7 @@ tags:
 1. In your browser, navigate to the `Borrowing Capacity` API documentation:
 
     ```text
-    http://localhost:3000/docs/hexy/get-an-estimate-of-your-borrowing-capacity
+    http://localhost:3000/hexyback-workshop/docs/hexy/get-an-estimate-of-your-borrowing-capacity
     ```
 
 2. Modify the sample request parameters:

diff --git a/docs/docs/loan-application/workshop-activities/create-infra.mdx b/docs/docs/loan-application/workshop-activities/create-infra.mdx
@@ -250,6 +250,6 @@ Kill the running documentation server (`Ctrl+C`) and run the following:
 pnpm run docs
 ```
 
-Navigate to: `http://localhost:3000/docs/hexy/apply-for-a-loan`. You'll see the updated API documentation for the `Apply for Loan` endpoint:
+Navigate to: `http://localhost:3000/hexyback-workshop/docs/hexy/apply-for-a-loan`. You'll see the updated API documentation for the `Apply for Loan` endpoint:
 
 ![`Apply for Loan` API Endpoint](/img/loan-application/updated-apply-for-loan-api-docs.png)
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -77,12 +77,16 @@ const config = {
         style: 'dark',
         links: [
           {
-            title: 'Docs',
+            title: 'Documentation',
             items: [
               {
-                label: 'Tutorial',
+                label: 'Workshop',
                 to: '/docs/intro',
               },
+              {
+                label: 'Hexy API',
+                to: '/docs/category/hexy-api',
+              },
             ],
           },
           {

diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -14,6 +14,7 @@
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
   // By default, Docusaurus generates a sidebar from the docs folder structure
+  workshopSidebar: [{ type: 'autogenerated', dirName: '.' }],
   openApiSidebar: [
     {
       type: 'category',