Skip to content

Revise documentation around Simulator and the docs family - #24

Merged
mcencini merged 31 commits into
mainfrom
docs/family-revision
Oct 5, 2026
Merged

mcencini merged 31 commits into
mainfrom
docs/family-revision

Conversation

@mcencini

@mcencini mcencini commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

Summary

  • align TorchSim with the documentation structure used by the other pulserver projects
  • make Simulator the canonical user-facing sequence extension point
  • explain the two complementary sequence paths: handlers for incoming Pulseq/MRD descriptions and layout() for offline construction
  • make the Framework examples an explicit Course and the remaining sections Tours
  • add an Explanations landing page and TL;DR summaries
  • centralize publication-scale figure styling with transparent light/dark-safe rendering
  • update stale repository/documentation links after the move to the pulserver organization
  • keep the functional *_sim calls documented as convenience wrappers rather than a second extension API

The implementation/API behavior is intentionally unchanged in this PR. Functional-wrapper parity is handled separately.

@mcencini
mcencini merged commit f13d47d into main Oct 5, 2026
28 checks passed
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