Skip to content

Add a shared glossary for recurring ESS/instrument jargon in the dashboard #1019

Description

@SimonHeybrock

Users with limited ESS/instrument background hit unexplained jargon throughout the dashboard — TOA, Q / momentum transfer, "cut axis", wavelength edges, "window" vs reduction cadence, pixel weighting. Individual descriptions help, but the same terms recur across workflows, params, and outputs, and explaining each one in full at every site is repetitive and inconsistent.

We should add a small, central glossary of recurring terms, defined once, and link to it from the places where the terms appear (workflow-config modal, plot-creation wizard, parameter tooltips).

This is a follow-up to the broader description/discoverability survey. The per-site description improvements (param↔output back-references, TOA default explanation, friendly enum labels, filling missing descriptions) are handled separately; this issue is specifically about the shared glossary so jargon is defined in one place rather than duplicated.

Open questions for design:

  • Where the glossary lives (a doc page, an in-app panel, or hover-cards).
  • How terms are linked from modals/tooltips without cluttering the UI.
  • Initial term set: TOA, Q (momentum transfer), wavelength edges/range, time window vs reduction cadence, pixel weighting, ROI.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions