Skip to content

Flesh out the in-app help drawers (images, worked examples, deeper coverage) #16

Description

@ApocDev

The ? help drawers (HelpButton in app/src/components/help-drawer.tsx) give a docs drawer on Coherence, Factory, What-if, TURD, Browse, the Block editor, and Tasks. The first pass is concise text, enough to orient. Later it should be more expansive:

  • Images and diagrams, for example the canceling-mismatch visual on Coherence, a worked block-solver example on the Block editor, and the in-game capture flow on Tasks.
  • Worked examples: a concrete "scale stone to 60/s" walkthrough, a real TURD pick and its effect, byproduct handling in hard mode.
  • Deeper coverage: the full item-disposition model, edge cases, and the bridge sync model.

Decide first where the expansive docs live:

  1. Cram more into the drawers, which is cramped for images and long-form.
  2. A wiki or docs site for the long-form, image-rich version, with each drawer linking to its page. Drawers stay the concise contextual layer.
  3. An in-app /docs route.

Leaning toward option 2: keep the drawers tight (contextual what and why) and host the deep, image-rich reference separately, with each drawer linking to its page.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: webWeb UI (React/TanStack/vite-plus)

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions