The documentation site for Brave Bot, a general-purpose agent with structural resistance to indirect prompt injection.
Read it at brave.github.io/bravebot.
Built with Docusaurus. .github/workflows/gh-pages.yml builds this
directory and publishes it on every push to main; nothing outside docs/website/build is
served, and no gh-pages branch is involved.
make install # install dependencies
make start # serve locally with live reloadmake on its own lists every target. The pnpm scripts still work if you prefer them:
pnpm install, pnpm start, pnpm run build. pnpm is provided by corepack enable.
make buildGenerates static content into build/, which can be served by any static host. Broken links
and anchors are build errors rather than warnings, so a clean build is also the correctness
check:
make checkFrom the repository root, make check-docs runs the same build the CI job runs, and
make check-all includes it.
src/pages/index.js is the page at /, and the Overview doc is at /overview. The hero's bots
and wordmark and its stars are static/img/bravebot-hero.svg and bravebot-stars.svg, each with a
-light twin that the page shows in the light colour mode. Do not edit them:
ui/scripts/readme-art.mjs writes them from the avatar generator the desktop app uses, and
node scripts/readme-art.mjs run in ui/ remakes them. The install commands and the feature cards
repeat the root README, so check them against it and the specs when those change. The site opens in
the dark colour mode whatever the system prefers (colorMode in docusaurus.config.js).
Everything here describes behaviour that is specified clause by clause in docs/specs. Where the two disagree, the specs are the source of truth: fix this site rather than documenting around it.
make check-spec at the repository root holds the specs to this site. Every spec's front matter
carries a documented-by naming the pages here that describe it, and the check fails when a spec
says nothing or names a page that is not there. A spec no page describes says none with the
reason in brackets, so grep -rn "none (gap" ../specs is what the site still owes.
That check answers which specs are documented, not whether what a page says is still true
after the behaviour underneath it changed. make docs-changes answers the second question:
it lists what has landed in the specs since the commit recorded in
docs-updated-to-sha. To fold those commits into these pages,
run the update-docs skill.