PolarBot reference
Everything PolarBot has, with no steps: the building blocks for the ultra-manual level.
These pages are generated from the source code by a test in crates/polarbot
(docs_reference). The test renders them from the real definitions (the registered commands
and their level checks, the config structs, the systemd unit, the database after every
migration, the log-level table) and fails when a checked-in page differs, so a change to the
code cannot ship without its reference page. To regenerate after a change:
POLAR_UPDATE_DOCS=1 cargo test -p polarbot docs_reference
| Page | What is in it |
|---|---|
| Commands | Every slash command and message command: subcommands, options (type, required, choices, limits), required level, DM availability |
| Configuration file | Every config key with its type, default and meaning |
| Credentials | The systemd credentials, their files and environment variables |
| Files and directories | Every path an installation uses |
| Database | Every table and column, with the personal data it holds and how long it is kept; the migrations |
| Log levels | What each log level 0–10 posts |
| Command line and exit codes | polarbot usage, exit statuses (including 78), gateway intents |
The units and scripts themselves are in the repository:
deploy/polarbot.service,
deploy/install.sh,
deploy/config.toml
and crates/polarbot/config.example.toml.