Documentation
Read the source. Understand the model.
MacLean is open source, so the most reliable documentation lives with the code. This index points to the canonical places for each topic.
- README & quick start β Build, test and run the Free edition from source.
- Safety model β How deletion stays safe: impact labels, trash-first, restore.
- Architecture β Crate layout, scanner, classification and platform contracts.
- CLI usage β Scan, classify and clean from the terminal (included in builds).
- Contributing guide β DCO, coding conventions and review process.
- Changelog What changed in each version.
Where do the official docs live?
In the public GitHub repository (docs/), alongside the code they describe. A dedicated docs site is planned for launch.
Version pinning: docs are updated with each release. If you are on an older version, check the tag matching your release.