Documentation
Project reference material and related documentation, published as browsable pages.
- Project structure
The canonical repository tree and the responsibilities of its apps, crates, integrations, and tooling.
- Papyrus Lint CLI Usage
The full call suite of the Papyrus Lint CLI.
- Examples
Real bugs Papyrus Lint catches that PapyrusCompiler.exe lets through, beyond the README's example.
- Annotations
Comment annotations for API metadata, lint suppression, and declaration visibility.
- Using PapyrusLinterCLI in a GitHub Action
A minimal GitHub Actions workflow that lints a project on every push and pull request.
- Configuration reference
The full papyrus-lint.yaml configuration reference: every key, presets, and desktop app settings.
- Command-line interface reference
The full PapyrusLinterCLI reference: every subcommand and flag, JSON output, and exit codes.
- Running Papyrus Lint in Docker
Running Papyrus Lint as a container in CI, and verifying release image/binary signatures.
- Fixing lint findings in the desktop app
How the desktop app applies, previews, and exports lint fixes.
- Compiling a script from the desktop app
How the desktop app compiles a script with PapyrusCompiler.exe and strips build machine info.
- Default configuration (papyrus-lint.yaml)
The full default papyrus-lint.yaml, with every key's default value documented inline.
- Papyrus Lint project configuration
The JSON Schema for papyrus-lint.yaml / papyrus-lint.yml project configuration files.
- Papyrus Lint CLI report
The JSON Schema for the report PapyrusLinterCLI --json emits.
- Papyrus Lint Export for AI document
The current JSON Schema for documents produced by the desktop app's Export for AI feature.
- Papyrus Lint Export for AI document
The frozen v4 JSON Schema for Export for AI documents, superseded by v5 above.
- Papyrus Lint Export for AI document
The frozen v3 JSON Schema for Export for AI documents, superseded by v4 above.
- Papyrus Lint Export for AI document
The frozen v2 JSON Schema for Export for AI documents, superseded by v3 above.
- Papyrus Lint Export for AI document
The frozen v1 JSON Schema for Export for AI documents, superseded by v2 above.