Bulletin Builder MkDocs documentation

This folder contains an English end-user guide generated from the supplied Bulletin Builder frontend.

Run locally

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
mkdocs serve

Open the local URL printed by MkDocs.

Build the static site

mkdocs build --strict

The generated site will be written to site/.

Documentation images

The docs/assets/screenshots/ images are source-faithful documentation captures generated from the supplied frontend structure, English labels, permissions, and workflows. They are intentionally independent from a live backend so the documentation can be built offline. If pixel-perfect production captures are required, replace the files with screenshots from the target deployment while keeping the same filenames.

JSON examples

Full example JSON files are stored in docs/assets/json/ and are included in the relevant pages using pymdownx.snippets. IDs, names, dates, and content values are illustrative; object structure and field names follow the supplied frontend types and forms.