Merge pull request #43 from credebl/feat/document-format-updation

feat: added collapse true for all submenus
credebl · Sep 27, 2024 · 4500e4f · 4500e4f
2 parents 717c8b0 + bb8e0e8
commit 4500e4f
Show file tree

Hide file tree

Showing 39 changed files with 323 additions and 240 deletions.
diff --git a/astro.config.mjs b/astro.config.mjs
@@ -55,6 +55,7 @@ export default defineConfig({
 			],
 			sidebar: [
 				{
+					collapsed: true,
 					label: 'Intro',
 					items: [
 						// Each item here is one entry in the navigation menu.
@@ -66,12 +67,15 @@ export default defineConfig({
 					],
 				},
 				{
+					collapsed: true,
 					label: "User Guide",
 					items: [
+
 						{ label: "Getting started", "link": "/en/userguide/getting-started" },
-						{ label: "Studio UI workflow", "link": "/en/userguide/ui-flow/" },
+						{ label: "Studio UI overview", "link": "/en/userguide/ui-flow/" },
 						{ label: "CREDEBL APIs guide", "link": "/en/userguide/api-flow/" },
 						{
+					collapsed: true,
 							label: "API Reference",
 							items: [
         				...openAPISidebarGroups,
@@ -80,83 +84,82 @@ export default defineConfig({
 					]
 				},
 				{
-					label: 'Contributors Guide',
+					collapsed: true,
+					label: 'Developers Guide',
 					items: [
 						// Each item here is one entry in the navigation menu.
 						{
-							label: "Getting started",
+							collapsed: true,
+							label: "Installation",
 							items: [
-								{ label: "Basic info", "link": "/en/contributorsguide/gettingstarted/basic-info/" },
-								{ label: "Architecture", "link": "/en/contributorsguide/gettingstarted/architecture/" },
-							]
-						},
-						{
-							label: "Setup",
-							items: [
-								//   { label: "Prerequisites", "link": "/en/contributorsguide/setup/prerequisites/prerequisitesoftwares/" },
 								{
+									collapsed: true,
 									label: "Prerequisites",
 									items: [
-										{ label: "Prerequisites", "link": "/en/contributorsguide/setup/prerequisites/prerequisitesoftwares/" },
-										{ label: "Keycloak", "link": "/en/contributorsguide/setup/prerequisites/keycloak/" },
-										{ label: "NATS", "link": "/en/contributorsguide/setup/prerequisites/nats/" },
-										{ label: "REDIS", "link": "/en/contributorsguide/setup/prerequisites/redis/" },
-										{ label: "PostgreSQL", "link": "/en/contributorsguide/setup/prerequisites/postgres/" },
+										{ label: "Prerequisites", "link": "/en/developersguide/setup/prerequisites/prerequisitesoftwares/" },
+										{ label: "Keycloak", "link": "/en/developersguide/setup/prerequisites/keycloak/" },
+										{ label: "NATS", "link": "/en/developersguide/setup/prerequisites/nats/" },
+										{ label: "REDIS", "link": "/en/developersguide/setup/prerequisites/redis/" },
+										{ label: "PostgreSQL", "link": "/en/developersguide/setup/prerequisites/postgres/" },
 									]
 								},
 								{
+									collapsed: true,
 									label: "Platform",
 									items: [
-										{ label: "Intro", "link": "/en/contributorsguide/setup/platform/intro/" },
 										{
-											label: "Basic setup",
+											collapsed: true,
+											label: "Installation",
 											items: [
-												{ label: "Using NPM", "link": "/en/contributorsguide/setup/platform/basicsetup/npm/" },
-												{ label: "Using Docker", "link": "/en/contributorsguide/setup/platform/basicsetup/docker/" },
+												{ label: "Using NPM", "link": "/en/developersguide/setup/platform/basicsetup/npm/" },
+												{ label: "Using Docker", "link": "/en/developersguide/setup/platform/basicsetup/docker/" },
 											]
 										},
-										{ label: ".env setup", "link": "/en/contributorsguide/setup/platform/envsetup/" },
-										{ label: "References", "link": "/en/contributorsguide/setup/platform/references/" },
+										{ label: "Environment Variables", "link": "/en/developersguide/setup/platform/envsetup/" },
+										{ label: "References", "link": "/en/developersguide/setup/platform/references/" },
 
 									]
 								},
 								{
+									collapsed: true,
 									label: "Agent",
 									items: [
-										{ label: "Intro", "link": "/en/contributorsguide/setup/agent/intro/" },
+										{ label: "Overview", "link": "/en/developersguide/setup/agent/overview/" },
 										{
-											label: "Basic setup",
+									collapsed: true,
+											label: "Installation",
 											items: [
-												{ label: "Using NPM", "link": "/en/contributorsguide/setup/agent/basicsetup/npm/" },
-												{ label: "Using Docker", "link": "/en/contributorsguide/setup/agent/basicsetup/docker/" },
+												{ label: "Using NPM", "link": "/en/developersguide/setup/agent/basicsetup/npm/" },
+												{ label: "Using Docker", "link": "/en/developersguide/setup/agent/basicsetup/docker/" },
 											]
 										},
-										{ label: ".env setup", "link": "/en/contributorsguide/setup/agent/envsetup/" },
-										{ label: "References", "link": "/en/contributorsguide/setup/agent/references/" },
+										{ label: "Environment Variables", "link": "/en/developersguide/setup/agent/envsetup/" },
+										{ label: "References", "link": "/en/developersguide/setup/agent/references/" },
 
 									]
 								},
 								{
+									collapsed: true,
 									label: "Studio",
 									items: [
-										{ label: "Intro", "link": "/en/contributorsguide/setup/studio/intro/" },
 										{
-											label: "Basic setup",
+									collapsed: true,
+											label: "Installation",
 											items: [
-												{ label: "Using NPM", "link": "/en/contributorsguide/setup/studio/basicsetup/npm/" },
-												{ label: "Using Docker", "link": "/en/contributorsguide/setup/studio/basicsetup/docker/" },
+												{ label: "Using NPM", "link": "/en/developersguide/setup/studio/basicsetup/npm/" },
+												{ label: "Using Docker", "link": "/en/developersguide/setup/studio/basicsetup/docker/" },
 											]
 										},
-										{ label: ".env setup", "link": "/en/contributorsguide/setup/studio/envsetup/" },
-										{ label: "References", "link": "/en/contributorsguide/setup/studio/references/" },
+										{ label: "Environment Variables", "link": "/en/developersguide/setup/studio/envsetup/" },
+										{ label: "References", "link": "/en/developersguide/setup/studio/references/" },
 
 									]
 								},
 
 
 							]
 						},
-						{ label: "Troubleshooting", "link": "/en/contributorsguide/troubleshooting/" },
+						{ label: "Troubleshooting", "link": "/en/developersguide/troubleshooting/" },
 
 
 					],

diff --git a/src/content/docs/en/contributorsguide/gettingstarted/architecture.md b/src/content/docs/en/contributorsguide/gettingstarted/architecture.md
diff --git a/src/content/docs/en/contributorsguide/setup/agent/envsetup.md b/src/content/docs/en/contributorsguide/setup/agent/envsetup.md
@@ -1,6 +1,6 @@
 ---
-title: .env setup
-description: .env setup
+title: Environment Variables
+description: Environment Variables
 ---
 
 ##### Refer following .env.sample file for externalized veriables. #####

diff --git a/src/content/docs/en/contributorsguide/setup/agent/references.md b/src/content/docs/en/contributorsguide/setup/agent/references.md
diff --git a/src/content/docs/en/contributorsguide/setup/platform/envsetup.md b/src/content/docs/en/contributorsguide/setup/platform/envsetup.md
diff --git a/src/content/docs/en/contributorsguide/setup/platform/intro.md b/src/content/docs/en/contributorsguide/setup/platform/intro.md
diff --git a/src/content/docs/en/contributorsguide/setup/studio/envsetup.md b/src/content/docs/en/contributorsguide/setup/studio/envsetup.md
diff --git a/...CREDEBL_OSS_Architecture-copy-sysArch.jpg → ...CREDEBL_OSS_Architecture-copy-sysArch.jpg b/...CREDEBL_OSS_Architecture-copy-sysArch.jpg → ...CREDEBL_OSS_Architecture-copy-sysArch.jpg
diff --git a/src/content/docs/en/developersguide/gettingstarted/architecture.md b/src/content/docs/en/developersguide/gettingstarted/architecture.md
@@ -0,0 +1,6 @@
+---
+title: CREDEBL Architecture
+description: Describe the CREDEBL Platform Architecture
+---
+
+To refer CREDEBL platform architecture <a href='/en/intro/architecture/'>click here</a> 
diff --git a/...ibutorsguide/gettingstarted/basic-info.md → ...elopersguide/gettingstarted/basic-info.md b/...ibutorsguide/gettingstarted/basic-info.md → ...elopersguide/gettingstarted/basic-info.md
diff --git a/...ibutorsguide/previouscontent/afj_setup.md → ...elopersguide/previouscontent/afj_setup.md b/...ibutorsguide/previouscontent/afj_setup.md → ...elopersguide/previouscontent/afj_setup.md
@@ -1,5 +1,5 @@
 ---
-title: Agent Setup
+title: Agent Installation
 description: Describe the CREDEBL Platform Architecture
 ---
 Docker image build in this process is used to start the agents for new organizations in CREDEBL platform.

diff --git a/...sguide/previouscontent/getting-started.md → ...sguide/previouscontent/getting-started.md b/...sguide/previouscontent/getting-started.md → ...sguide/previouscontent/getting-started.md
@@ -5,9 +5,9 @@ description: A reference page in my new CREDEBL docs site.
 
 ## Setting Up CREDEBL
 
-Welcome to the CREDEBL Platform Setup Guide! This manual will walk you through the process of installing CREDEBL on your local machine. Let's get started.
+Welcome to the CREDEBL Platform Installation Guide! This manual will walk you through the process of installing CREDEBL on your local machine. Let's get started.
 
-### Initial Setup
+### Initial Installation
 
 There are two ways you can setup the platform: 
 - Using [NPM](/en/guides/local-setup-using-npm/) directly by cloning the repository   OR
@@ -34,7 +34,7 @@ Before you begin with the project, make sure the following software's are instal
 
 The CREDEBL Platform, being open source , mandates user authentication and utilizes a database for storing agent wallets and platform data. Keycloak is used as a database service.
 
-To set up keycloak for authentication follow the [Keycloak Setup using Docker](/en/guides/keycloak) section. Learn more about keycloak from their [official website](https://www.keycloak.org/).
+To set up keycloak for authentication follow the [Keycloak Installation using Docker](/en/guides/keycloak) section. Learn more about keycloak from their [official website](https://www.keycloak.org/).
 
 **SendGrid** 
 

diff --git a/...eviouscontent/local-setup-using-docker.md → ...eviouscontent/local-setup-using-docker.md b/...eviouscontent/local-setup-using-docker.md → ...eviouscontent/local-setup-using-docker.md
diff --git a/.../previouscontent/local-setup-using-npm.md → .../previouscontent/local-setup-using-npm.md b/.../previouscontent/local-setup-using-npm.md → .../previouscontent/local-setup-using-npm.md
diff --git a/...torsguide/previouscontent/self-hosting.md → ...persguide/previouscontent/self-hosting.md b/...torsguide/previouscontent/self-hosting.md → ...persguide/previouscontent/self-hosting.md
diff --git a/...de/previouscontent/using-credebl-cloud.md → ...de/previouscontent/using-credebl-cloud.md b/...de/previouscontent/using-credebl-cloud.md → ...de/previouscontent/using-credebl-cloud.md
diff --git a/...orsguide/setup/agent/basicsetup/docker.md → ...ersguide/setup/agent/basicsetup/docker.md b/...orsguide/setup/agent/basicsetup/docker.md → ...ersguide/setup/agent/basicsetup/docker.md
diff --git a/...butorsguide/setup/agent/basicsetup/npm.md → ...lopersguide/setup/agent/basicsetup/npm.md b/...butorsguide/setup/agent/basicsetup/npm.md → ...lopersguide/setup/agent/basicsetup/npm.md