Contact
Use GitHub Issues for questions and bug reports. A de-identified sample and clear reproduction steps help us investigate.
01 · Channels
Where to write
- Bugs, template requests, and questions: open an issue at github.com/okht/zhi/issues. This is the primary channel and the one with public history, so a question answered there helps the next person.
- Fixes and new templates: pull requests are welcome at github.com/okht/zhi/pulls. Run
python3 scripts/build.py --checkbefore opening one; it covers template lint, design-token sync, and public-fact drift.
Support is provided through the project repository on a best-effort basis. Please remove personal information from documents and screenshots before sharing a report.
02 · Reports
What to include
Most layout reports stall on missing context. These four lines usually unblock a fix.
- The template name, for example
resume-enorslides-weasy, and the Zhi version from the homepage badge orVERSION. - How it was invoked: the Claude Code plugin, the Codex plugin, a Claude Desktop upload, the MCP server, or a direct
scripts/build.pyrun. - The rendered artifact, a PDF or a page PNG, rather than a description of it. Layout problems are visual and a screenshot settles most of them immediately.
- The output of the relevant check, for example
python3 scripts/build.py --check-content content.json filled.html, if the document verified clean but still looks wrong.
For rendering failures, the exact error text matters: WeasyPrint, pypdf, and PyMuPDF are optional dependencies, and a missing one surfaces as an install hint rather than a crash. Pasting that hint is usually the whole diagnosis.