Skip to content

Docs content refinement pass (follow-up to #460) #472

Description

@goodboy

Motivation

PR #460 stood up the new docs site (pydata theme, d2 diagrams,
tested examples) as a scaffold + middle ground — the structure,
wiring, and current-API correctness are in, but substantial prose
still needs filling / refining across the guides. This issue tracks
that content pass so #460 can land immediately as the scaffold.

Scope

Refine + flesh out the written content across the docs tree
(docs/). Fill in per-page bullet notes as the refinement passes
happen:

Known thread to fold in here:

  • Sweep the guide pages for any run_in_actor()-led showcase
    examples and reframe where the Context API should lead (e.g. the
    inlined snippets in guide/rpc.rst + guide/spawning.rst and
    their backing scripts). NB most existing refs already correctly
    cast run_in_actor() as the convenience wrapper atop the core
    Portal.open_context() model — keep those; this is the
    headline-example pass, not a blanket purge.

Notes

(this issue was generated in some part by claude-code)

Metadata

Metadata

Assignees

No one assigned

    Labels

    discussiondocsexamplesfollow-upleftover TODOs from a patchhelp wantedExtra attention is neededintegrationOptional/loose support for 3rd party libs/apps/projects

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions