Public documentation for the SupportMail Discord bot.
Guides for server admins, moderators and users of SupportMail, covering setup, configuration, handling tickets and reports, and troubleshooting. The site is published at docs.supportmail.dev.
The bot's behavior is configured from a web dashboard and used through Discord commands, so the explanations live apart from the bot's code. This repository holds that documentation as an Astro site using Starlight, with pages written in Markdown and MDX and deployed to Cloudflare Workers.
Requires Node.js 26+ and pnpm 12 (see engines and packageManager in package.json).
git clone git@github.com:supportmailapp/docs.git
cd docs
pnpm installpnpm dev # start the local dev server
pnpm check:content # run the content rules
pnpm build # build to ./dist and prune unpublished markdown copies
pnpm preview # preview the build- Pages marked
draft: trueare not published;scripts/prune-drafts.mjsremoves the markdown copies thatstarlight-contextual-menustill writes for them, and the build fails if any survive. - Old
/f/...links from the bot and dashboard are served by a redirect route, so renaming a page can break a link that lives outside this repository. - Search needs Algolia credentials (
ALGOLIA_APP_IDand related variables); without them the search box is not functional locally.
See CONTRIBUTING.md. Contributors are expected to follow the Code of Conduct.
Code: MIT © SupportMail
Documentation content: CC BY-NC-SA 4.0 © SupportMail