ScanSlicer/docs
dan 426a18f342 chore: prune boilerplate and refresh stale docs
- Remove 257 redundant per-definition comment stubs across the package
- Drop dead nonlocal declarations in autoslicer_detection.py
- Document the swapped flag and swap_left_right in architecture docs
- Remove unsupported 'legacy override' claims from autotune/runtime docs
2026-09-11 23:07:30 +02:00
..
appimage.md build: harden dependency supply chain 2026-09-11 23:07:30 +02:00
architecture.md chore: prune boilerplate and refresh stale docs 2026-09-11 23:07:30 +02:00
autotune.md chore: prune boilerplate and refresh stale docs 2026-09-11 23:07:30 +02:00
development.md docs: add contributor workflow reference 2026-02-28 11:03:20 +00:00
parameters.md docs: add detection parameter reference 2026-02-28 11:08:20 +00:00
README.md docs: add documentation index 2026-02-27 11:53:42 +00:00
runtime-config.md chore: prune boilerplate and refresh stale docs 2026-09-11 23:07:30 +02:00
user-guide.md docs: add end-user operation reference 2026-02-27 11:58:42 +00:00

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.
  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