← Home

Getting help#

Stuck, or found a bug? Try self-service first: the runbooks and guides (demolab docs lists them, demolab docs <NAME> opens one) cover most operating questions. When you still need a human, here’s where to go.

Where to ask#

GitHub issues are the place: bugs, feature requests, and questions about the framework. Issues are searchable, so your question helps the next person and the fix lands in the open.

Install the GitHub CLI (gh — e.g. brew install gh, then gh auth login) and your coding agent can file issues for you: describe the problem and ask it to submit — it will gather the details below, write the report, and post it with gh issue create.

Writing a report that gets answered#

Before opening an issue, run the doctor (say “doctor the repo”), check the guides and runbooks, and search existing issues. Then include, in order:

• What you ran and what happened: the exact command and the full error output, not a paraphrase.
• Toolchain versions: uv --version, typst --version, demolab version.
• The commit: demolab stamps the git SHA into the page/PDF footer, so paste that line or run git rev-parse --short HEAD.
• Framework or content?: state whether it’s the engine (a demolab bug) or your own tool/experiment/writing. Ask if you’re unsure.
• A minimal repro if you can: the smallest writing or tool that triggers it.

You can also just type SUPPORT in capitals and the coding agent will walk you through all of this interactively.

The full reference lives in SUPPORT.md.