goodboy
/
tractor
1
0
Fork 2
Code Issues 5 Pull Requests 8 Packages Projects Releases Wiki Activity

WIP: First draft d2 sequence diagrams for .msg.types #20

Draft
goodboy wants to merge 1 commits from sc_super_proto_dgrams into main
pull from: sc_super_proto_dgrams
merge into: goodboy:main
Conversation 0 Commits 1 Files Changed 1
goodboy commented 2025-03-26 17:14:01 +00:00
Owner

Documenting nearly all possible MsgType flows so they can eventually be paired with matching code snippets in our (hopefully) soon to be reworked docs.

ToDos before landing,

  • figure out how to embed these in sphinx .rst docs alongside our big docs rework!
  • it’d sure be nice to be able to auto-gen these dgrams with a builtin-extension using something like py2-d2
    • for ex. we could introspect the type annots on various@context defs and then generate all possible flows to provide easily groked sequences for any tractor “app”?
Documenting nearly all possible `MsgType` flows so they can eventually be paired with matching code snippets in our (hopefully) soon to be reworked docs. --- ToDos before landing, ----------------------- - [ ] figure out how to embed these in `sphinx` `.rst` docs alongside our big docs rework! - [ ] it'd sure be nice to be able to auto-gen these dgrams with a builtin-extension using something like [py2-d2](https://github.com/mrblenny/py-d2) - for ex. we could introspect the type annots on various`@context` defs and then generate all possible flows to provide easily groked sequences for any `tractor` "app"?
goodboy added 1 commit 2025-03-26 17:14:01 +00:00
d0d59d59f0 First draft `d2` sequence diagrams for `.msg.types` 
Documenting nearly all possible `MsgType` flows so they can eventually
be paired with matching code snippets in our (hopefully) soon to be
reworked docs.
goodboy changed title from First draft `d2` sequence diagrams for `.msg.types` to WIP: First draft `d2` sequence diagrams for `.msg.types` 2025-03-26 17:14:21 +00:00
This pull request is marked as a work in progress.
This branch is out-of-date with the base branch
You can also view command line instructions.

Step 1:

From your project repository, check out a new branch and test the changes.
git checkout -b sc_super_proto_dgrams main
git pull origin sc_super_proto_dgrams

Step 2:

Merge the changes and update on Gitea.
git checkout main
git merge --no-ff sc_super_proto_dgrams
git push origin main
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No Label
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
1 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: goodboy/tractor#20
There is no content yet.
Delete Branch "sc_super_proto_dgrams"

Deleting a branch is permanent. Although the deleted branch may exist for a short time before cleaning up, in most cases it CANNOT be undone. Continue?