Support | RusDox Documentation

Where To Start

Before opening an issue, check:

For usage and authoring questions, start a thread in GitHub Discussions Q&A. Keep Issues for reproducible bugs and scoped feature work.

Share a real, non-confidential output in Show and tell, or propose a viewer/format priority in Ideas. Use synthetic or public fixtures only: never attach client documents, secrets, personal data, proprietary templates, or private parity artifacts.

Use Issues For

confirmed bugs
clear feature requests
template requests that would help many users
cross-platform problems
regressions in YAML, DOCX, PDF, config, or CLI behavior

Include These Details

operating system
RusDox version or commit
config file if relevant
YAML spec if relevant
exact command you ran
expected result
actual result

Fastest Way To Get Help

If the problem is about authoring:

start from an example YAML file
reduce the case to a minimal spec
include that minimal spec in the issue

If the problem is about styling:

include the relevant rusdox.toml
say whether the issue is in DOCX, PDF, or both

If the problem is about Rust API usage:

include a minimal Rust snippet
say whether you are using DocumentSpec, Studio, or low-level Document builders

Security Issues

Read SECURITY.md before reporting anything security-sensitive.