Skip to content

Docs & Presets (user guide + sample templates) #197

@sharwell

Description

@sharwell

Summary

Document how to enable/configure face frames and provide preset layouts.

Current Behavior

No user guidance or presets for face frames.

Expected Behavior

README/user docs updated with steps, defaults, and example cabinets; presets available in UI.

Steps to Reproduce

  1. Open docs; follow steps to create a face frame cabinet.
  2. Choose a preset (Double Doors, 3‑Drawer Stack) and confirm expected results.

Technical Description

  • Add a “Face Frame” section to docs calling out units and invariants.
  • Bundle two preset JSON snippets.

Best Practice Reference

  • Calls out invariants per project docs and AGENTS.md.

Implementation Notes

  • Include screenshots of dialog and Outliner hierarchy.

Proposed solutions

Option A

Inline docs in README.

Option B

Separate docs/face-frame.md referenced from README.

Acceptance Criteria

  • Docs explain inputs, outputs, and limitations (MVP scope).
  • Presets appear in UI and match solver expectations.
  • Screenshots current and minimal.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions