{"id":30434327,"url":"https://github.com/botpress/docs","last_synced_at":"2026-02-11T07:31:34.499Z","repository":{"id":288448324,"uuid":"948171264","full_name":"botpress/docs","owner":"botpress","description":"Botpress Documentation","archived":false,"fork":false,"pushed_at":"2026-02-02T18:30:42.000Z","size":60890,"stargazers_count":6,"open_issues_count":1,"forks_count":66,"subscribers_count":5,"default_branch":"master","last_synced_at":"2026-02-03T04:46:48.174Z","etag":null,"topics":["agent","ai","botpress","documentation"],"latest_commit_sha":null,"homepage":"https://botpress.com/docs","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/botpress.png","metadata":{"files":{"readme":"README.md","changelog":"changelog-assets/2025-05-02/display-last-message-date.png","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-03-13T21:43:48.000Z","updated_at":"2026-02-02T18:30:45.000Z","dependencies_parsed_at":"2025-07-09T23:35:30.656Z","dependency_job_id":"b3f1c8ed-3399-4a70-a485-c12cbfc0f30f","html_url":"https://github.com/botpress/docs","commit_stats":null,"previous_names":["botpress/docs"],"tags_count":0,"template":false,"template_full_name":"mintlify/starter","purl":"pkg:github/botpress/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botpress%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botpress%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botpress%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botpress%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/botpress","download_url":"https://codeload.github.com/botpress/docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/botpress%2Fdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29329493,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T06:13:03.264Z","status":"ssl_error","status_checked_at":"2026-02-11T06:12:55.843Z","response_time":97,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agent","ai","botpress","documentation"],"created_at":"2025-08-22T23:35:11.930Z","updated_at":"2026-02-11T07:31:34.490Z","avatar_url":"https://github.com/botpress.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Botpress Documentation\n\nWelcome to the Botpress documentation repository. This project powers the docs site of Botpress, the complete AI Agent platform.\n\nTo get started with contributions, please review the entire README.\n\n## Prerequisites\n\nTo contribute, install the following software if you haven't already:\n\n- [VS Code](https://code.visualstudio.com), [Cursor](https://cursor.com/agents), or another text editor\n- [Node.js](https://nodejs.org/) (v18 or higher)\n- [pnpm](https://pnpm.io/) package manager\n- [Vale](https://vale.sh/) for writing style checks (optional but recommended)\n- [Mintlify CLI](https://www.mintlify.com/docs) for the local development server\n\n## Getting started\n\n1. **Clone the repository:**\n\n   ```bash\n   git clone https://github.com/botpress/docs.git\n   cd docs\n   ```\n\n2. **Install dependencies:**\n\n   ```bash\n   pnpm install\n   ```\n\n3. **Start the development server:**\n   ```bash\n   mint dev\n   ```\n   This will start a local Mintlify server at `http://localhost:3000`.\n\n## Project structure\n\nThe Botpress documentation is built with [Mintlify](https://mintlify.com/). Here's how the project is organized:\n\n```\ndocs/\n├── docs.json              # Mintlify configuration \u0026 navigation\n├── home.mdx               # Homepage content\n├── studio/                # Documentation for Botpress Studio\n├── integrations/          # Integration documentation\n├── webchat/              # Webchat-specific docs\n├── adk/                   # Documentation for the Botpress Agent Development Kit (ADK)\n├── api-reference/        # API documentation\n├── snippets/             # Reusable content snippets\n├── changelog.mdx         # Product changelog\n├── *-openapi.json        # OpenAPI specifications\n└── assets/               # Images and other static files\n```\n\n## Content guidelines\n\n### MDX\n\nAll documentation is written in MDX (Markdown with JSX components). You can find full list of supported components in the [Mintlify documentation](https://mintlify.com/docs/text).\n\n\u003e [!NOTE]\n\u003e\n\u003e If you're using VS Code or Cursor, we recommend also installing the official Mintlify extension. This will enable autocomplete for most Mintlify components.\n\n### Images\n\n- Mintlify supports [responsive light/dark images](https://mintlify.com/docs/image-embeds#light-and-dark-mode-images). If you're using UI screenshots, make sure you include both a light and dark version.\n- Wrap all images in Mintlify's [Frame](https://mintlify.com/docs/components/frames) component.\n- Include appropriate alt text for all images\n\nIf you're using VS Code or Cursor, you can use the snippet at `/.vscode/mdx.code-snippets` for any images.\n\n### Navigation\n\nThe `docs.json` file at the root of the repository determines the navigation structure of the documentation. If you're adding new pages, make sure you update `docs.json` to include them.\n\n### Check writing\n\nBotpress uses [Vale](https://vale.sh) to enforce consistent style and branding throughout the documentation. Vale executes on all pull requests in this repository.\n\nYou can also run Vale locally using the Vale CLI:\n\n1. [Install Vale](https://vale.sh/docs/install) if you haven't already\n2. Download the required packages:\n\n```\nvale sync\n```\n\n3. Run a writing check against files you've modified:\n\n```\nmake check-writing\n```\n\n\u003e [!NOTE]\n\u003e\n\u003e If you need Vale to ignore a certain flag within the context you're writing about, you can use [comment-based configuration](https://vale.sh/docs/formats/markdown#comments) to disable rules within a given section.\n\n### Integrations\n\nAll integration documentation can be found in `/integrations/integration-guides`. While configuration steps are hand-written, reference documentation for Cards and Triggers is automatically generated and updated on a weekly schedule.\n\nIf you're working on documentation for an integration:\n\n1. Make sure its file name is the same as the integration's name.\n2. Define a `.env` file at the project's root with your Botpress Personal Access Token (PAT) as `BOTPRESS_TOKEN` and Botpress workspace ID as `BOTPRESS_WORKSPACE_ID`:\n3. Before pushing your changes, run:\n\n   ```zsh\n   pnpm run update-integrations\n   ```\n\n   This will fetch the most up-to-date information for any integrations modified on the current branch.\n\n\u003e [!TIP]\n\u003e\n\u003e You can also update a single integration:\n\u003e\n\u003e ```zsh\n\u003e pnpm run update-integrations \u003cintegration-name\u003e\n\u003e ```\n\u003e\n\u003e or update all integrations at once:\n\u003e\n\u003e ```zsh\n\u003e pnpm run update-integrations --bulk\n\u003e ```\n\n### Check links\n\nTo check for broken links, run:\n\n```\nmint broken-links\n```\n\nThis check also runs on every pull request in the repository.\n\n## Development workflow\n\n### Make a change\n\n1. Fork the repository\n2. Create a feature branch: `git checkout -b name/feature/your-improvement`\n3. Make your changes following our style guidelines\n4. Test your changes locally with `mint dev`\n5. Validate writing style with `make check-writing` (if Vale is installed)\n6. Check for broken links using `mint broken-links`\n7. Submit a pull request with a clear description of your changes\n\n### Raise an issue\n\nUse this repository for specific documentation-related issues only. Report any product bugs (or general documentation feedback) via [Discord](https://discord.gg/botpress).\n\n## Support\n\nJoin the conversation on our [Discord](https://discord.gg/botpress) server for any other questions related to Botpress—we'd love to hear from you.\n\nThank you for helping us improve the Botpress documentation!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbotpress%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbotpress%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbotpress%2Fdocs/lists"}