2.7 KiB
2.7 KiB
Advanced concepts and project internals
This guide collects material that is useful after the normal CLI, configuration, output, and editor workflows are familiar. The root README and documentation path remain the best entry points for day-to-day use.
Detection model and evaluation
- Heuristics and evidence scoring describes applicability, occurrence damping, normalization, and why the score is not authorship confidence.
- Review signals and evidence methodology records the research basis, evidence tiers, and signals deliberately kept out.
- Evaluation records corpus provenance, per-rule measurements, aggregate false positives, and the limits of the current metrics.
- Limitations covers evasion, domain shift, interpretation, and operational boundaries.
Architecture and embedding
- Architecture and public API describes the Cargo workspace, module boundaries, shared domain values, streaming input, and reusable facade.
- Output contracts specifies human presentation and the versioned JSON Lines schema for downstream integrations.
- Decision records preserve the reasoning behind core contracts, input limits, the LSP protocol, and the supported workspace.
- Crate-boundary experiment contains the measurements that preceded the workspace decision.
Performance, dependencies, and safety
- Performance benchmarks defines representative workloads and the evidence required before adding parallel execution.
- Dependency and binary review records feature choices, advisory and license policy, unsafe boundaries, and release-size measurements.
- Security policy explains supported versions and private vulnerability reporting.
Research references
- Background collects external context on observable signs of low-care AI-assisted writing.
- Ambiguous and invisible Unicode references records Gitea's locale-aware catalog, its upstream source, and safe adoption boundaries.
Development and release engineering
- Development covers the Rust toolchain, feature matrix, tests, snapshots, coverage, badges, and CI gates.
- Contributing explains the patch workflow and review expectations; AGENTS.md defines repository-specific rules for coding agents.
- Release procedure defines tagged reproducible packaging, checksums, and provenance metadata.
- Implementation plan records completed milestones and deferred product work.