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)
Motivation
PR #460 stood up the new docs site (
pydatatheme,d2diagrams,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 passeshappen:
(TODO @goodboy — bullet notes per page/guide)
update the caps-based-msging section
to include Type annotating
Context.open_stream()(probably withmsgspec.Structsubtype(s)) 😎 #365 which is the primary most recent issue whichprotos out our longer term type-annot-driven
pld_specAPI.also point to our current test suites which i'm pretty
already demo a higher-level approach then using
tractor.msg._ops.limit_plds()?also link in the new
enc/dec_hook()factor PRenc_hook&dec_hookfactory (+ CIuvupdate) #376 (from@guilledk) as the (potential) longer term refined public API.
(which needs a serious rebase!)
adding (at least
tractor.*) typing to allexamples/scripts scripts like the front page
one
adjustments for when we move
Portal.run_in_actor()intoa
tractor.hilevel/apior wtv.proper
Registrar-as-subsys (not the root actor) example set(ideally with multiple proto backends per ).
a whole detailed guide section on the SCSP (SC supervision
protocol) per tHe GoD uNpRoToCoL #297
and extending the dgram @ https://goodboy.github.io/tractor/guide/context.html#the-context-a-cross-actor-task-pair
add more complex scenarios such as requested loong ago
😂 Deployment Scenarios and Testing #97
Recipe for "actor class" style stuff like
rayandpykka#191Add a "farming" example. #238
Document an "infected asyncio" sub-actor tutorial #180
celery" all intractorper,Impress the celery crowd #83
debug_mode=Truefeats in an actual complex distributed sysper, The debugger readme example is deprecated #270
actually post about the project, likely on the
triodiscourseforum per,
Pump eet? #2
Known thread to fold in here:
run_in_actor()-led showcaseexamples and reframe where the
ContextAPI should lead (e.g. theinlined snippets in
guide/rpc.rst+guide/spawning.rstandtheir backing scripts). NB most existing refs already correctly
cast
run_in_actor()as the convenience wrapper atop the corePortal.open_context()model — keep those; this is theheadline-example pass, not a blanket purge.
Notes
d2pipeline, gh-pages deploy, testedexamples) is done in Docs (vibed) for serious: real documentation with a modern theme #460; this issue is purely content.
https://github.com/goodboy/tractor/issues?q=is%3Aissue+state%3Aopen+label%3Adocs
(this issue was generated in some part by
claude-code)