Skip to content

Documentation Index

Every page in the documentation set and every generated file beside it, with one line on what each covers, so you can find the right page before you open one.

  • index.md: Site landing page for the docs site and local builds.
  • OPTIONS_GUIDE.md: Every parameter rendered from the model, with images.
  • options-guide.html: The same guide as one self-contained file that works offline.
  • PARAMETER_REFERENCE.md: Complete section-by-section and variable-by-variable parameter reference.
  • MODULE_REFERENCE.md: Module-by-module geometry reference and render flow.
  • SCAD_ARCHITECTURE.md: Core architecture, data flow, and coordinate-system details.
  • VALIDATION_RULES.md: Assertion constraints, triggers, and resolution guidance.
  • PARAMETER_INTERACTIONS.md: Cross-parameter behavior and tuning order.
  • WORKFLOWS.md: Practical setup, calibration, slicing, and troubleshooting workflows.
  • PRINTING.md: Printing-specific baseline settings and process guidance, including Gridfinity, magnets, edge treatment, and the fit test box.
  • FAQ.md: Common questions and issue resolution.
  • RELEASE.md: Release checklist, from version bump through the drafted GitHub release that .github/workflows/release.yml creates from a tag.
  • ../library/README.md: The nine presets, what each fits, and their sizes. The same catalogue with 3D previews and downloads is the preset library, which resolves to the browser on the docs site and to the generated directory when browsing the repository.
  • ../library/index.json: The catalogue as data, generated alongside the presets. Each preset’s overrides, printed envelope, feature flags and file paths, plus the model’s full parameter defaults once at the top.
  • ../cable-box-parametric.json: All nine presets as one OpenSCAD parameter-set file, so the Customizer lists them when the model is opened. Generated.
  • ../web/astro.config.mjs: Docs site navigation/config (Astro Starlight).
  • ../web/sync-docs.mjs: Syncs this directory into the site at build time, so docs/ stays the single source of truth.
  • .github/workflows/docs-pages.yml: GitHub Pages publish workflow.
  • .github/workflows/scad-smoke.yml: GitHub Actions OpenSCAD smoke workflow.
  • scripts/scad-smoke.ps1 / scripts/scad-smoke.sh: Local smoke render scripts.
Terminal window
cd web
npm ci
npm run dev

Open http://localhost:4321.