Brooked Docs

Open-source documentation for Brooked's connectors — what each one imports, what credentials it needs, and how to connect it.

Built with Docusaurus. Licensed under MIT — issues and PRs welcome.

Structure

• docs/intro.md — landing page
• docs/connectors/*.md — one page per connector, generated (see below) — don't hand-edit these, your changes will be overwritten next regeneration
• docs/connectors/overview.md — index of every connector, grouped by category, also generated

Local development

npm install
npm start

Starts a hot-reloading dev server at http://localhost:3000.

npm run build

Builds the static site into build/.

Deployment

This repo deploys to GitHub Pages automatically on every push to main via .github/workflows/deploy.yml.