From 0b26c66021138408b49bfe8da99382e5e4f06b10 Mon Sep 17 00:00:00 2001 From: dev Date: Fri, 27 Feb 2026 11:53:42 +0000 Subject: [PATCH] docs: add documentation index --- docs/README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..5f8bc64 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,24 @@ +# 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`