Skip to content

docs: add high-level "purpose, role & how to read the numbers" guide #116

@grzanka

Description

@grzanka

Part of #108 (health-review epic). Subsumes the units concern in #48.

Context

The reference docs and README are accurate but assume domain knowledge. A new user (or a web/Python consumer) cannot easily answer: what is this, what does each program cover, which units do I get, and when is a number native vs. extended?

Proposed change

Add a top-level conceptual section (in index.rst / docs landing) covering:

Acceptance criteria

  • A conceptual overview page exists and is linked from the docs landing page and README.
  • Units for every public quantity are documented with a worked example.
  • Per-program coverage (ions + energy range + source) is tabulated.
  • The native-vs-fallback caveat is explained and cross-linked.

References

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    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