From e0862ef2e62d653be68214eba4278d706a5f703a Mon Sep 17 00:00:00 2001
From: Abraham Lopez <10536776+AbrahamLopez10@users.noreply.github.com>
Date: Thu, 6 Jun 2024 16:21:53 -0400
Subject: [PATCH] chore: move Files API handbook to For Developers section
(#334)
* chore: move Files API handbook to For Developers section
* fix CSS issue in home page
---
.../NavigationCardList/NavigationCardList.tsx | 4 ++--
pages/cloud/_meta.json | 1 -
pages/developers/_meta.json | 6 +++---
pages/developers/{ => api-handbook}/chat.mdx | 0
.../api-handbook/files-api.mdx | 0
pages/developers/index.mdx | 15 ++++++++++-----
6 files changed, 15 insertions(+), 11 deletions(-)
rename pages/developers/{ => api-handbook}/chat.mdx (100%)
rename pages/{cloud => developers}/api-handbook/files-api.mdx (100%)
diff --git a/components/NavigationCardList/NavigationCardList.tsx b/components/NavigationCardList/NavigationCardList.tsx
index e08548c1..b9c81e2f 100644
--- a/components/NavigationCardList/NavigationCardList.tsx
+++ b/components/NavigationCardList/NavigationCardList.tsx
@@ -12,7 +12,7 @@ export function NavigationCardList(props: NavigationCardListProps) {
>
{props.cards.map((card) => (
-
+
-
{card.heading}
+
{card.heading}
{card.subHeading}
diff --git a/pages/cloud/_meta.json b/pages/cloud/_meta.json
index 9db71560..e433b642 100644
--- a/pages/cloud/_meta.json
+++ b/pages/cloud/_meta.json
@@ -2,7 +2,6 @@
"index": "Home",
"getting-started": "Getting Started",
"admin-dashboard": "Admin Dashboard",
- "api-handbook": "API Handbook",
"generative-ai": "Generative AI",
"studio": "Studio Interface",
"toolbox": "Toolbox",
diff --git a/pages/developers/_meta.json b/pages/developers/_meta.json
index f8eaa398..d513d25e 100644
--- a/pages/developers/_meta.json
+++ b/pages/developers/_meta.json
@@ -4,10 +4,10 @@
"moving-parts": "Moving Parts",
"cli": "CLI",
"sdk": "SDK",
- "howTo":"How To",
+ "howTo": "How To",
"concepts": "Key Concepts",
- "webchat": "Web Chat old",
+ "webchat": "Web Chat v1 (old)",
"webchat-v2": "Web Chat v2",
- "chat": "Chat API",
+ "api-handbook": "API Handbook",
"publishing-to-botpress-hub": "Publishing to Botpress Hub"
}
diff --git a/pages/developers/chat.mdx b/pages/developers/api-handbook/chat.mdx
similarity index 100%
rename from pages/developers/chat.mdx
rename to pages/developers/api-handbook/chat.mdx
diff --git a/pages/cloud/api-handbook/files-api.mdx b/pages/developers/api-handbook/files-api.mdx
similarity index 100%
rename from pages/cloud/api-handbook/files-api.mdx
rename to pages/developers/api-handbook/files-api.mdx
diff --git a/pages/developers/index.mdx b/pages/developers/index.mdx
index 9c2563b3..e31f6f33 100644
--- a/pages/developers/index.mdx
+++ b/pages/developers/index.mdx
@@ -1,10 +1,15 @@
-This document aims to provide a comprehensive guide to the Botpress Cloud developer experience. After reading it, you should be able to create and manage Bots and Integrations using the CLI and SDK.
+# Botpress for Developers
+
+This document aims to provide a comprehensive guide to the Botpress Cloud developer experience. After reading it, you should be able to:
+
+- Create and manage Bots and Integrations using the CLI and SDK.
+- Use the Botpress Cloud API to interact with the platform, notably the Chat API and Files API.
## Prerequisites
We assume you are a programmer that knows the JavaScript ecosystem and already has a basic knowledge of Botpress. Among other things, the reader should:
-- have built at least one Chatbot with Botpress Cloud Studio
-- be comfortable with the command line (either Bash, Powershell or any other shell)
-- be familiar with [Node.js](https://nodejs.org/en/), recommended version 18.x.x or later
-- be familiar with [TypeScript](https://www.typescriptlang.org/)
+- Have built at least one Chatbot with Botpress Cloud Studio.
+- Be comfortable with the command line (either Bash, Powershell or any other shell).
+- Be familiar with [Node.js](https://nodejs.org/en/), recommended version 18.x.x or later.
+- Be familiar with [TypeScript](https://www.typescriptlang.org/).