Skip to content

Add the usage and plugin authoring guides - #67

Merged
SizzleUnrlsd merged 2 commits into
mainfrom
docs/usage
Sep 4, 2026
Merged

SizzleUnrlsd merged 2 commits into
mainfrom
docs/usage

Conversation

@SizzleUnrlsd

Copy link
Copy Markdown
Contributor

Summary

Third and last deliverable of the product track: the usage documentation.

  • Acceptance tests first (test: define what the usage documentation covers): the guides must name every command-line option, every rule the shipped plugins can report, the three report formats and the exit codes, every plugin base class and model kind of the plugin API, every bundled plugin, and every command they show must use options that exist.
  • docs/usage.md: install, quick start, the option table, what is analysed and how taint travels, the rules grouped by family with their triggers and how flows are judged, the text, JSON and SARIF reports, advisories (OSV import, local file format), policy and SBOM, cache and jobs, the bundled plugins, a GitHub Actions example uploading SARIF, use from Python, the supported syntax and the intermediate representation.
  • docs/plugins.md: plugin layout and loading, the manifest fields, canonical symbols, one example per kind of plugin (SymbolCallDetector, TaintDetector, ModelPlugin with the table of the ten model kinds and advisories, SecretDetector, ProjectPlugin, raw Plugin with the analyses it can read), findings, and how to test a plugin with the engine.
  • README trimmed to an overview with the install command and links to the three documents; its stale description of the pipeline as "deferred" is gone, and the long option-by-option prose moved into the usage guide.

@SizzleUnrlsd SizzleUnrlsd self-assigned this Sep 4, 2026
@SizzleUnrlsd
SizzleUnrlsd merged commit 72ff7c7 into main Sep 4, 2026
10 checks passed
@SizzleUnrlsd
SizzleUnrlsd deleted the docs/usage branch September 4, 2026 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant