Skip to content

Conversation

@mfisher87
Copy link
Collaborator

@mfisher87 mfisher87 commented Oct 24, 2025

Added "You should notice..." callouts throughout

Removed/condensed unnecessary text

Fleshed out learning objectives (maybe these should be removed entirely in favor of outcomes?)

You -> we language

Removed comment about SSH setup (sorry @ktaletsk! The current instructions set up token auth, so users don't actually have to input their username and password)

Add placeholder time estimates for each exercise

Simplify outcomes

Other wording / clarity tweaks


https://diataxis.fr/tutorials/#tutorials

  • Show the learner where they’ll be going
  • Deliver visible results early and often
  • Maintain a narrative of the expected
  • Point out what the learner should notice
  • Target the feeling of doing
  • Encourage and permit repetition
  • Ruthlessly minimise explanation
  • … and focus on the concrete
  • Ignore options and alternatives
  • Aspire to perfect reliability

I don't think we're there on all of these, I'd like your feedback on how we can get closer :)


🔍 Preview: https://jupytercon2025-developingextensions--49.org.readthedocs.build/
Note: This Pull Request preview is provided by ReadTheDocs. Our production website, however, is currently deployed with GitHub Pages.

@mfisher87 mfisher87 merged commit 9ce3333 into main Oct 26, 2025
2 checks passed
@mfisher87 mfisher87 deleted the more-consistent-voice branch October 26, 2025 18:22
@mfisher87 mfisher87 linked an issue Oct 27, 2025 that may be closed by this pull request
7 tasks
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.

More consistent language and formatting in Anatomy of an Extension module

3 participants