How to use
- Copy the installation command and review the source package before installing it in your own agent environment.
- Check the source document for required tools, credentials and supported hosts.
- Describe your input and desired deliverable; review the output against the source material.
npx skills add https://github.com/brainbrewlabs/brainbrew-devkit --skill docsBefore you start
- Installation does not include a model subscription, API allowance or permission to access your files.
- Repository stars and installation counts describe activity, not an independent quality or security test.
Original skill document
Rendered from the source repository. Headings, examples, code, tables, links, and referenced images are preserved.
Documentation Site
Build Docs
bash
npm run docs:buildOutput: docs/.vitepress/dist/
Preview Locally
bash
npm run docs:devOpens at http://localhost:5173/brainbrew-devkit/
Deploy to GitHub Pages
Docs auto-deploy on push to main when files in docs/ change.
Manual trigger:
bash
git add docs/ && git commit -m "docs: update" && git pushOr trigger via GitHub Actions UI.
Site Structure
docs/
index.md # Landing page
guide/ # Getting started, tutorials
skills/ # Skill reference
templates/ # Workflow templates
agents/ # Agent reference
api/ # MCP tools, hooksAdd New Page
- Create
docs/<section>/<name>.md - Add to sidebar in
docs/.vitepress/config.ts - Build and verify:
npm run docs:build
Update Existing Page
- Edit the
.mdfile - Preview:
npm run docs:dev - Commit and push to deploy
Common Tasks
| Task | Command |
|---|---|
| Dev server | npm run docs:dev |
| Build | npm run docs:build |
| Preview build | npm run docs:preview |
| Deploy | Push to main |
