Skip to content
supportmailappPublic

About

Public documentation for the SupportMail Discord bot.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

SupportMail Docs

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.

Table of Contents

Background

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.

Install

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 install

Usage

pnpm 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

Caveats

  • Pages marked draft: true are not published; scripts/prune-drafts.mjs removes the markdown copies that starlight-contextual-menu still 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_ID and related variables); without them the search box is not functional locally.

Contributing

See CONTRIBUTING.md. Contributors are expected to follow the Code of Conduct.

License

Code: MIT © SupportMail

Documentation content: CC BY-NC-SA 4.0 © SupportMail

About

Public documentation for the SupportMail Discord bot.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Used by

Contributors

Languages