57 lines
2.6 KiB
Markdown
57 lines
2.6 KiB
Markdown
# 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](../README.md) and [documentation path](README.md) remain the best entry
|
|
points for day-to-day use.
|
|
|
|
## Detection model and evaluation
|
|
|
|
- [Heuristics and evidence scoring](heuristics.md) describes applicability,
|
|
occurrence damping, normalization, and why the score is not authorship
|
|
confidence.
|
|
- [Evaluation](evaluation.md) records corpus provenance, per-rule measurements,
|
|
aggregate false positives, and the limits of the current metrics.
|
|
- [Limitations](limitations.md) covers evasion, domain shift, interpretation,
|
|
and operational boundaries.
|
|
|
|
## Architecture and embedding
|
|
|
|
- [Architecture and public API](architecture.md) describes the Cargo workspace,
|
|
module boundaries, shared domain values, streaming input, and reusable facade.
|
|
- [Output contracts](output.md) specifies human presentation and the versioned
|
|
JSON Lines schema for downstream integrations.
|
|
- [Decision records](decisions/) preserve the reasoning behind core contracts,
|
|
input limits, the LSP protocol, and the supported workspace.
|
|
- [Crate-boundary experiment](experiments/crate-boundary.md) contains the
|
|
measurements that preceded the workspace decision.
|
|
|
|
## Performance, dependencies, and safety
|
|
|
|
- [Performance benchmarks](benchmarks.md) defines representative workloads and
|
|
the evidence required before adding parallel execution.
|
|
- [Dependency and binary review](dependencies.md) records feature choices,
|
|
advisory and license policy, unsafe boundaries, and release-size measurements.
|
|
- [Security policy](../SECURITY.md) explains supported versions and private
|
|
vulnerability reporting.
|
|
|
|
## Research references
|
|
|
|
- [Background](background.md) collects external context on observable signs of
|
|
low-care AI-assisted writing.
|
|
- [Ambiguous and invisible Unicode references](unicode-confusables.md) records
|
|
Gitea's locale-aware catalog, its upstream source, and safe adoption
|
|
boundaries.
|
|
|
|
## Development and release engineering
|
|
|
|
- [Development](development.md) covers the Rust toolchain, feature matrix,
|
|
tests, snapshots, coverage, badges, and CI gates.
|
|
- [Contributing](../CONTRIBUTING.md) explains the patch workflow and review
|
|
expectations; [AGENTS.md](../AGENTS.md) defines repository-specific rules for
|
|
coding agents.
|
|
- [Release procedure](releasing.md) defines tagged reproducible packaging,
|
|
checksums, provenance, and CycloneDX SBOM generation.
|
|
- [Implementation plan](../tasks.md) records completed milestones and deferred
|
|
product work.
|