Repository navigation
docs: add sequence diagrams and up-front mental models #399
Description
From the review result:
Provide bare bones mental models from the various user perspectives up front or in the examples section. [...] I feel like a UML sequence diagram would bring a ton to understanding the component interactions.
Source: Boost review result (conditional acceptance), Boost mailing list, September 2026.
The docs currently contain zero diagrams. The mermaid Antora extension is already registered in doc/local-playbook.yml but unused. The review names three audiences (users, higher-level library authors, protocol implementers); no page presents a per-audience mental model.
- Sequence diagram: task spawn, suspend on I/O, resume through the executor
- Sequence diagram: cancellation via stop token
- A short "mental model" page or example-section preamble per audience
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
- Status
Activity
docs: address review of the mental-models and cancellation pages
docs: replace the double-resuming stoppable awaitable example
docs: show posting without a claim as the dangerous stop-callback pat…
docs: show the two long examples expanded until boostlook styles summary
docs: fix the gated wording findings on the landing page
docs: fix the doc-audit findings on lines this branch changed
docs: add sequence diagrams and per-audience mental models
docs: add sequence diagrams and per-audience mental models
docs: style the sequence diagrams like Corosio's benchmark charts
docs: darken diagram box outlines and space collapsibles like paragraphs
docs: add sequence diagrams and per-audience mental models
docs: add sequence diagrams and a protocol anatomy to the introduction
docs: add sequence diagrams and a protocol anatomy to the introduction