Getting help
Thanks for using AssayPDF. Before opening an issue, please check the docs — most setup and runtime questions are answered there.
Self-serve
Section titled “Self-serve”| Question | Where to look |
|---|---|
| How do I install it? | docs/install.md |
| How do I run an end-to-end benchmark? | docs/usage.md |
What does flag --foo do? | docs/cli.md |
| Something errored — is this known? | docs/troubleshooting.md, docs/known-quirks.md |
| How do I reproduce a published score? | docs/reproducing.md |
| How does the scoring methodology work? | docs/methodology.md |
| Why is the architecture set up this way? | docs/architecture.md, docs/adr/ |
Asking a question
Section titled “Asking a question”If the docs don’t answer it, open a GitHub Discussion in the Q&A category. Include:
- What you’re trying to do.
- What you ran (exact command).
- What happened vs. what you expected.
- AssayPDF version (
uv run assay --version), Python version, OS, and the version of any preflight engine involved.
Reporting a bug
Section titled “Reporting a bug”Open a bug report. The template asks for the information needed to triage quickly.
Proposing new rule coverage or an engine runner
Section titled “Proposing new rule coverage or an engine runner”Use the New rule coverage template, or open a feature request describing the engine you want to benchmark. See CONTRIBUTING.md for the implementation shape.
Reporting a security issue
Section titled “Reporting a security issue”Do not open a public issue. See SECURITY.md for the private reporting channel.
Commercial support
Section titled “Commercial support”AssayPDF is maintained by Think Neverland alongside lintPDF (PDF preflight SaaS, in private development). For commercial integration questions, email [email protected].