25 lines
893 B
Markdown
25 lines
893 B
Markdown
|
# ScanSlicer Docs
|
||
|
|
|
||
|
|
This folder contains in-depth documentation for ScanSlicer.
|
||
|
|
|
||
|
|
## Contents
|
||
|
|
|
||
|
|
- `docs/user-guide.md`: How to use the application end-to-end.
|
||
|
|
- `docs/architecture.md`: Module layout, responsibilities, and runtime flow.
|
||
|
|
- `docs/parameters.md`: Detection parameter catalog (defaults, ranges, and effects).
|
||
|
|
- `docs/autotune.md`: Auto-tune profiles, candidate search, scoring, and feedback learning.
|
||
|
|
- `docs/runtime-config.md`: Backend selection, environment variables, and persistence paths.
|
||
|
|
- `docs/appimage.md`: Local and Docker AppImage build workflows.
|
||
|
|
- `docs/development.md`: Developer-oriented codebase and workflow notes.
|
||
|
|
|
||
|
|
## Recommended Reading Order
|
||
|
|
|
||
|
|
1. `README.md` (project overview and quick start)
|
||
|
|
2. `docs/user-guide.md`
|
||
|
|
3. `docs/parameters.md`
|
||
|
|
4. `docs/autotune.md`
|
||
|
|
5. `docs/architecture.md`
|
||
|
|
6. `docs/runtime-config.md`
|
||
|
|
7. `docs/appimage.md`
|
||
|
|
8. `docs/development.md`
|