Skip to content

Make Addressable rustdoc teach complete workflows - #2

Merged
waywardmonkeys merged 2 commits into
mainfrom
codex/rustdoc-workflows
Aug 26, 2026
Merged

Make Addressable rustdoc teach complete workflows#2
waywardmonkeys merged 2 commits into
mainfrom
codex/rustdoc-workflows

Conversation

@waywardmonkeys

Copy link
Copy Markdown
Contributor

This follow-up makes Addressable's public documentation navigable from both crate-level workflows and individual type pages.

  • Explain which values callers construct, which values hosts produce, and where each pivotal result goes next.
  • Add focused doctests for resolution, querying, explanation, guarded edits, live replay, correspondence, and dynamic tooling.
  • Reshape the executable tour into five narrated chapters.
  • Carry dynamic observation space and revision in DynamicExplanation so guarded tooling operations no longer require typed host access.

Dynamic guards require the space and revision that produced their observed value. Returning only the subject and value forced dynamic callers to reach through ReferenceTool into Basilica.

Carry that context in DynamicExplanation so tooling can construct a guarded transaction using only the dynamic boundary.
Explain who constructs or receives each pivotal type, where its evidence comes from, and which operation consumes it.

Reserve doctests for real workflows and static laws, and keep isolated constructor invariants in unit tests.

Reshape the executable tour into five narrated chapters while retaining its semantic assertions.
@waywardmonkeys
waywardmonkeys force-pushed the codex/rustdoc-workflows branch from 9b6e657 to 41ca04b Compare August 24, 2026 18:35
@waywardmonkeys
waywardmonkeys merged commit c38bc29 into main Aug 26, 2026
11 checks passed
@waywardmonkeys
waywardmonkeys deleted the codex/rustdoc-workflows branch August 26, 2026 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant