From 223f867173ed8ab8eafcfc240c72df46cddbe6c8 Mon Sep 17 00:00:00 2001 From: Adrian Kahali Date: Thu, 15 Jan 2026 15:07:01 -0500 Subject: [PATCH] fix: add title frontmatter --- adk/concepts/conversations.mdx | 4 ++++ adk/concepts/workflows/steps.mdx | 5 +++++ adk/introduction.mdx | 4 ++++ adk/project-structure.mdx | 4 ++++ adk/quickstart.mdx | 4 ++++ api-reference/admin-api/concepts.mdx | 4 ++++ api-reference/admin-api/getting-started.mdx | 4 ++++ api-reference/authentication.mdx | 4 ++++ api-reference/errors.mdx | 4 ++++ api-reference/files-api/getting-started.mdx | 4 ++++ api-reference/files-api/how-tos/index-and-search-files.mdx | 4 ++++ api-reference/files-api/how-tos/manage-files.mdx | 4 ++++ api-reference/introduction.mdx | 4 ++++ api-reference/pagination.mdx | 4 ++++ api-reference/ratelimiting.mdx | 4 ++++ desk/introduction.mdx | 4 ++++ get-started/configure-your-workspace.mdx | 4 ++++ integrations/integration-guides/attio.mdx | 1 + integrations/integration-guides/gmail.mdx | 1 + integrations/integration-guides/instagram.mdx | 1 + integrations/integration-guides/klaviyo.mdx | 1 + integrations/integration-guides/pipedrive.mdx | 1 + integrations/integration-guides/slack.mdx | 1 + integrations/sdk/installation.mdx | 4 ++++ studio/concepts/cards/set-inactivity-timeout.mdx | 4 ++++ studio/concepts/cards/tables.mdx | 4 ++++ studio/concepts/triggers.mdx | 1 + tutorial/basics/custom-logic/workflows.mdx | 4 ++++ tutorial/basics/first-steps/adding-knowledge.mdx | 4 ++++ tutorial/basics/first-steps/prompting.mdx | 4 ++++ tutorial/basics/storing-information/assigning-a-value.mdx | 4 ++++ tutorial/basics/storing-information/scoping-variables.mdx | 4 ++++ tutorial/basics/storing-information/variables.mdx | 4 ++++ tutorial/introduction.mdx | 1 + webchat/react-library/components/composer.mdx | 6 +++++- webchat/react-library/components/container.mdx | 4 ++++ webchat/react-library/components/header.mdx | 6 +++++- webchat/react-library/components/webchat.mdx | 4 ++++ 38 files changed, 131 insertions(+), 2 deletions(-) diff --git a/adk/concepts/conversations.mdx b/adk/concepts/conversations.mdx index 556e5292..35b8aa9e 100644 --- a/adk/concepts/conversations.mdx +++ b/adk/concepts/conversations.mdx @@ -1,3 +1,7 @@ +--- +title: Conversations +--- + Conversations are the primary way your agent handles user messages. Each conversation handler defines how your agent responds to messages from specific channels. ## Creating a conversation diff --git a/adk/concepts/workflows/steps.mdx b/adk/concepts/workflows/steps.mdx index b56c7d95..f6486a6d 100644 --- a/adk/concepts/workflows/steps.mdx +++ b/adk/concepts/workflows/steps.mdx @@ -1,3 +1,8 @@ +--- +title: Steps +--- + + This page contains a full reference for the [`step` function](/adk/concepts/workflows/overview#steps). ```typescript diff --git a/adk/introduction.mdx b/adk/introduction.mdx index 2f628159..069813f5 100644 --- a/adk/introduction.mdx +++ b/adk/introduction.mdx @@ -1,3 +1,7 @@ +--- +title: Introduction to the ADK +--- + ```ts Basic agent diff --git a/adk/project-structure.mdx b/adk/project-structure.mdx index 07d03448..d64e2db1 100644 --- a/adk/project-structure.mdx +++ b/adk/project-structure.mdx @@ -1,3 +1,7 @@ +--- +title: Project structure +--- + ADK projects follow a consistent structure that organizes your agent's code, configuration, and dependencies. ## Directory structure diff --git a/adk/quickstart.mdx b/adk/quickstart.mdx index e1ead352..22842d83 100644 --- a/adk/quickstart.mdx +++ b/adk/quickstart.mdx @@ -1,3 +1,7 @@ +--- +title: Quickstart +--- + This guide walks you through installing the ADK and creating your first agent project. diff --git a/api-reference/admin-api/concepts.mdx b/api-reference/admin-api/concepts.mdx index dfea7d66..40cc8d94 100644 --- a/api-reference/admin-api/concepts.mdx +++ b/api-reference/admin-api/concepts.mdx @@ -1,3 +1,7 @@ +--- +title: Concepts +--- + The **Admin API** is used to manage the surrounding infrastructure of the bots. It handles accounts, workspaces, users, quotas, billing, and other administrative functions. ## Account diff --git a/api-reference/admin-api/getting-started.mdx b/api-reference/admin-api/getting-started.mdx index 832bb296..bd524262 100644 --- a/api-reference/admin-api/getting-started.mdx +++ b/api-reference/admin-api/getting-started.mdx @@ -1,3 +1,7 @@ +--- +title: Getting started +--- + import adminApiPayloadSize from '/snippets/api-payload-limits.mdx' The Admin API allows administrators to manage users, settings, and logs within the platform. This guide will help you quickly get up and running with the API. diff --git a/api-reference/authentication.mdx b/api-reference/authentication.mdx index 80c8bbb6..603b0e07 100644 --- a/api-reference/authentication.mdx +++ b/api-reference/authentication.mdx @@ -1,3 +1,7 @@ +--- +title: Authentication +--- + You can authenticate to Botpress's API (`api.botpress.cloud`) as a user, a bot, or an integration. To do so, you'll need to use a token. If you are looking to use the Webchat API or the Chat API to talk to your bot, please refer to the [Chat API documentation](/api-reference/chat-api/introduction) and [Webchat documentation](/webchat/get-started/introduction). diff --git a/api-reference/errors.mdx b/api-reference/errors.mdx index 9318e4f1..6b55c46d 100644 --- a/api-reference/errors.mdx +++ b/api-reference/errors.mdx @@ -1,3 +1,7 @@ +--- +title: Errors +--- + ## Error Response Types When an error occurs while calling an API endpoint, the response will return the appropriate HTTP status code as indicated below. The following table outlines possible error type and its corresponding description and status. diff --git a/api-reference/files-api/getting-started.mdx b/api-reference/files-api/getting-started.mdx index e9ce4e0c..010678fb 100644 --- a/api-reference/files-api/getting-started.mdx +++ b/api-reference/files-api/getting-started.mdx @@ -1,3 +1,7 @@ +--- +title: Getting started +--- + import filesApiPayloadSize from "/snippets/api-payload-limits.mdx" The Files API allows you to upload, download, and manage files and searchable documents for your bots and integrations in Botpress Cloud. diff --git a/api-reference/files-api/how-tos/index-and-search-files.mdx b/api-reference/files-api/how-tos/index-and-search-files.mdx index 57cdfdf5..42afabe4 100644 --- a/api-reference/files-api/how-tos/index-and-search-files.mdx +++ b/api-reference/files-api/how-tos/index-and-search-files.mdx @@ -1,3 +1,7 @@ +--- +title: Index and search files +--- + ## Creating an indexed file If you need to index a file for semantic search just pass the `index: true` parameter when creating the file. diff --git a/api-reference/files-api/how-tos/manage-files.mdx b/api-reference/files-api/how-tos/manage-files.mdx index 219a5b3d..ee605ae9 100644 --- a/api-reference/files-api/how-tos/manage-files.mdx +++ b/api-reference/files-api/how-tos/manage-files.mdx @@ -1,3 +1,7 @@ +--- +title: Manage files +--- + ## Getting the file's metadata To get the details of a file you can use the [Get File](/api-reference/files-api/how-tos/manage-files#getting-the-file’s-metadata) API endpoint. diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx index 44be1504..3e66f36d 100644 --- a/api-reference/introduction.mdx +++ b/api-reference/introduction.mdx @@ -1,3 +1,7 @@ +--- +title: Introduction +--- + At Botpress, we love APIs. Every API we develop—whether public or private—is carefully designed with a strong focus on coherence and consistency. API design is at the core of our development process. Botpress is also a very big and complex system, and there isn't a single API that does everything. Instead, we provide multiple APIs, each tailored to specific functionalities. Below is a comprehensive list of all publicly available APIs in Botpress. Each API has dedicated documentation section. diff --git a/api-reference/pagination.mdx b/api-reference/pagination.mdx index 90fd0826..bb99844e 100644 --- a/api-reference/pagination.mdx +++ b/api-reference/pagination.mdx @@ -1,3 +1,7 @@ +--- +title: Pagination +--- + Our APIs return paginated results. Our paging is based on a cursor-based pagination system, which means that the API returns a set of results and a cursor (`nextToken`) that you can use to retrieve the next set of results. You can use this cursor in 2 ways: ## 1. Pagination with API Query Parameters diff --git a/api-reference/ratelimiting.mdx b/api-reference/ratelimiting.mdx index 3ba4eabc..dd5d895c 100644 --- a/api-reference/ratelimiting.mdx +++ b/api-reference/ratelimiting.mdx @@ -1,3 +1,7 @@ +--- +title: Rate limiting +--- + Our APIs are protected using a sliding window rate limiter. This means that exceeding the allowed number of requests per time window will result in a `429 Too Many Requests` (rate-limited) response. The rate limiter returns for each request the following headers: diff --git a/desk/introduction.mdx b/desk/introduction.mdx index 82d4decd..19c4cf81 100644 --- a/desk/introduction.mdx +++ b/desk/introduction.mdx @@ -1,3 +1,7 @@ +--- +title: Desk +--- + Desk is a **customer experience workspace for human-AI teams**. It combines a familiar interface with powerful AI-assisted tools, like: - Suggested answers to customer messages diff --git a/get-started/configure-your-workspace.mdx b/get-started/configure-your-workspace.mdx index 9482afdb..3cad0858 100644 --- a/get-started/configure-your-workspace.mdx +++ b/get-started/configure-your-workspace.mdx @@ -1,3 +1,7 @@ +--- +title: Configure your workspace +--- + In Botpress, your workspace is the environment where you organize, manage, and collaborate on your agent projects. Each Workspace can contain multiple agents, so you can keep them organized by customer, department, or use case. Within a workspace, you can manage permissions, usage, billing, and more. diff --git a/integrations/integration-guides/attio.mdx b/integrations/integration-guides/attio.mdx index d2f45192..66230aa0 100644 --- a/integrations/integration-guides/attio.mdx +++ b/integrations/integration-guides/attio.mdx @@ -1,4 +1,5 @@ --- +title: Attio description: Add a bot to Attio using the official integration. icon: '/integrations/integration-guides/assets/icons/attio.png' --- diff --git a/integrations/integration-guides/gmail.mdx b/integrations/integration-guides/gmail.mdx index 4c929aff..f5c17da2 100644 --- a/integrations/integration-guides/gmail.mdx +++ b/integrations/integration-guides/gmail.mdx @@ -1,4 +1,5 @@ --- +title: Gmail icon: '/integrations/integration-guides/assets/icons/gmail.svg' --- diff --git a/integrations/integration-guides/instagram.mdx b/integrations/integration-guides/instagram.mdx index d598d3b0..18279c43 100644 --- a/integrations/integration-guides/instagram.mdx +++ b/integrations/integration-guides/instagram.mdx @@ -1,4 +1,5 @@ --- +title: Instagram description: Add your bot to Instagram using the official integration. icon: '/integrations/integration-guides/assets/icons/instagram.svg' --- diff --git a/integrations/integration-guides/klaviyo.mdx b/integrations/integration-guides/klaviyo.mdx index e1accdd1..172f070e 100644 --- a/integrations/integration-guides/klaviyo.mdx +++ b/integrations/integration-guides/klaviyo.mdx @@ -1,4 +1,5 @@ --- +title: Klaviyo description: Add a bot to Klaviyo using the official integration. icon: '/integrations/integration-guides/assets/icons/klaviyo.png' --- diff --git a/integrations/integration-guides/pipedrive.mdx b/integrations/integration-guides/pipedrive.mdx index c2c4abe8..ea689697 100644 --- a/integrations/integration-guides/pipedrive.mdx +++ b/integrations/integration-guides/pipedrive.mdx @@ -1,4 +1,5 @@ --- +title: Pipedrive description: Add a bot to Pipedrive using the official integration. icon: '/integrations/integration-guides/assets/icons/pipedrive.svg' --- diff --git a/integrations/integration-guides/slack.mdx b/integrations/integration-guides/slack.mdx index a1745275..8678bd30 100644 --- a/integrations/integration-guides/slack.mdx +++ b/integrations/integration-guides/slack.mdx @@ -1,4 +1,5 @@ --- +title: Slack description: Add a bot to Slack using the official integration. icon: '/integrations/integration-guides/assets/icons/slack.svg' --- diff --git a/integrations/sdk/installation.mdx b/integrations/sdk/installation.mdx index 87c3078c..9f8a2701 100644 --- a/integrations/sdk/installation.mdx +++ b/integrations/sdk/installation.mdx @@ -1,3 +1,7 @@ +--- +title: Installation +--- + To get started, install the Botpress CLI globally on your machine. The CLI includes the Botpress SDK and other useful packages for developing with Botpress. Run the following command in your terminal: diff --git a/studio/concepts/cards/set-inactivity-timeout.mdx b/studio/concepts/cards/set-inactivity-timeout.mdx index 2a267828..2a33af8f 100644 --- a/studio/concepts/cards/set-inactivity-timeout.mdx +++ b/studio/concepts/cards/set-inactivity-timeout.mdx @@ -1,3 +1,7 @@ +--- +title: Set inactivity timeout +--- + You can use the Set Inactivity Timeout Card to **override the default inactivity timeout** configured in your [Bot Settings](/studio/concepts/bot-settings#inactivity-timeout). diff --git a/studio/concepts/cards/tables.mdx b/studio/concepts/cards/tables.mdx index 9c11d5a4..226e8ffd 100644 --- a/studio/concepts/cards/tables.mdx +++ b/studio/concepts/cards/tables.mdx @@ -1,3 +1,7 @@ +--- +title: Tables +--- + You can use table Cards to perform operations on data you have stored in a table. This page contains a list of available table Cards. diff --git a/studio/concepts/triggers.mdx b/studio/concepts/triggers.mdx index 180a31fa..33e8267e 100644 --- a/studio/concepts/triggers.mdx +++ b/studio/concepts/triggers.mdx @@ -1,4 +1,5 @@ --- +title: Triggers icon: play --- diff --git a/tutorial/basics/custom-logic/workflows.mdx b/tutorial/basics/custom-logic/workflows.mdx index 4eb8b801..805c20bd 100644 --- a/tutorial/basics/custom-logic/workflows.mdx +++ b/tutorial/basics/custom-logic/workflows.mdx @@ -1,3 +1,7 @@ +--- +title: Workflows +--- + import { GoodToKnow } from '/snippets/tutorial/good-to-know.mdx' So far, we've only had our bot generate responses using AI. In practice, though, you might run into situations where you want your bot to perform some hard-coded logic. diff --git a/tutorial/basics/first-steps/adding-knowledge.mdx b/tutorial/basics/first-steps/adding-knowledge.mdx index d56d3f09..16a81624 100644 --- a/tutorial/basics/first-steps/adding-knowledge.mdx +++ b/tutorial/basics/first-steps/adding-knowledge.mdx @@ -1,3 +1,7 @@ +--- +title: Adding knowledge +--- + Now that our bot has a custom prompt, let's try asking it a question: diff --git a/tutorial/basics/first-steps/prompting.mdx b/tutorial/basics/first-steps/prompting.mdx index b00359c6..de0a2d24 100644 --- a/tutorial/basics/first-steps/prompting.mdx +++ b/tutorial/basics/first-steps/prompting.mdx @@ -1,3 +1,7 @@ +--- +title: Prompting +--- + In Botpress, an AI agent is a bot that follows a *prompt* (instructions) to respond to users. You can view your bot's prompt in Studio. After skipping the initial setup, select **Edit in Studio**. This opens Studio in a new tab—you'll see the prompt under ** Instructions** at the top of the page. It should look something like this: diff --git a/tutorial/basics/storing-information/assigning-a-value.mdx b/tutorial/basics/storing-information/assigning-a-value.mdx index 1d1f4913..b1f9ad04 100644 --- a/tutorial/basics/storing-information/assigning-a-value.mdx +++ b/tutorial/basics/storing-information/assigning-a-value.mdx @@ -1,3 +1,7 @@ +--- +title: Assigning a value +--- + import { GoodToKnow } from '/snippets/tutorial/good-to-know.mdx' A newly-created variable is like an empty box—you need put something inside it before you can use it. This is called *assigning a value* to your variable. diff --git a/tutorial/basics/storing-information/scoping-variables.mdx b/tutorial/basics/storing-information/scoping-variables.mdx index 7ebabb4f..e0a0056e 100644 --- a/tutorial/basics/storing-information/scoping-variables.mdx +++ b/tutorial/basics/storing-information/scoping-variables.mdx @@ -1,3 +1,7 @@ +--- +title: Scoping variables +--- + import { GoodToKnow } from '/snippets/tutorial/good-to-know.mdx' Every variable has a *scope* that determines where and when your bot can access it. diff --git a/tutorial/basics/storing-information/variables.mdx b/tutorial/basics/storing-information/variables.mdx index acdf0b54..825681e1 100644 --- a/tutorial/basics/storing-information/variables.mdx +++ b/tutorial/basics/storing-information/variables.mdx @@ -1,3 +1,7 @@ +--- +title: Variables +--- + Sometimes, it's useful for your bot to remember some information—for example, about a specific user or conversation. You can do this using *variables*. A variable is a container that lets you store information from somewhere in Botpress Studio and reuse it somewhere else. diff --git a/tutorial/introduction.mdx b/tutorial/introduction.mdx index cbd9fa7c..a6d7dfe4 100644 --- a/tutorial/introduction.mdx +++ b/tutorial/introduction.mdx @@ -1,4 +1,5 @@ --- +title: Introduction icon: chef-hat --- diff --git a/webchat/react-library/components/composer.mdx b/webchat/react-library/components/composer.mdx index fdc7cad2..89b5f949 100644 --- a/webchat/react-library/components/composer.mdx +++ b/webchat/react-library/components/composer.mdx @@ -1,3 +1,7 @@ +--- +title: Composer +--- + The `Composer` component is where the user writes messages before sending them to the bot. It provides a text area for input, file uploads, and a speech-to-text option. @@ -85,4 +89,4 @@ The `Composer` component is where the user writes messages before sending them t type="Ref" > Provides a ref to the text input element. Useful for focusing or manipulating the input programmatically. - \ No newline at end of file + diff --git a/webchat/react-library/components/container.mdx b/webchat/react-library/components/container.mdx index 389647e2..31ab7ada 100644 --- a/webchat/react-library/components/container.mdx +++ b/webchat/react-library/components/container.mdx @@ -1,3 +1,7 @@ +--- +title: Container +--- + The `Container` wraps the core Webchat interface. It manages: diff --git a/webchat/react-library/components/header.mdx b/webchat/react-library/components/header.mdx index 78db041a..ab4f7784 100644 --- a/webchat/react-library/components/header.mdx +++ b/webchat/react-library/components/header.mdx @@ -1,3 +1,7 @@ +--- +title: Header +--- + The `Header` component sits at the top of the Webchat UI. It displays the bot’s name, avatar, and description. It also provides access to key actions like restarting the conversation or closing the chat window. @@ -141,4 +145,4 @@ The `Header` component sits at the top of the Webchat UI. It displays the bot’ - \ No newline at end of file + diff --git a/webchat/react-library/components/webchat.mdx b/webchat/react-library/components/webchat.mdx index 86cf1df2..4e76d1a6 100644 --- a/webchat/react-library/components/webchat.mdx +++ b/webchat/react-library/components/webchat.mdx @@ -1,3 +1,7 @@ +--- +title: Webchat +--- + The `Webchat` component is a batteries-included implementation of the Webchat window. It contains most of what you'd expect when [injecting Webchat](/webchat/get-started/quick-start).