Skip to content

Technical-writer review of the Topic guides (docs/reference/*) #155

@israel-dryer

Description

@israel-dryer

Apply the same editorial standard the how-to guides (and now reference/theming.rst) meet to the remaining Topic guides under docs/reference/:

  • Lead with the mental model up front (don't bury foundational concepts in a later section).
  • No kitchen-sink paragraphs — one idea per paragraph; make it scannable.
  • Tight, accurate, API-verified examples (show the relevant import on first use).
  • Sentence-case section headers; Title Case page title (per the casing convention in CLAUDE.md).

Pages to review (theming ✅ done):

  • data-sources, events, signals, streams, validation, localization, shortcuts, scheduling, store, errors, typography, images

Separate branch/initiative (does not gate the API-freeze work). The how-to guides are already signed off — leave them.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions