Skip to content

Adjust callout guidance - #270

Merged
froggleston merged 1 commit into
mainfrom
callouts-optional
Feb 7, 2026
Merged

froggleston merged 1 commit into
mainfrom
callouts-optional

Conversation

@tobyhodges

Copy link
Copy Markdown
Member

Now that we have a spoiler class of fenced div, I prefer to encourage developers of new lessons to use that for optional content, asides, etc. I think the callout callout is best used for the opposite: to draw attention to a particularly important point. That is the advice we give in Collaborative Lesson Development Training and this PR updates the Component Guide to match.

@github-actions

github-actions Bot commented Feb 6, 2026 •

Copy link
Copy Markdown

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/carpentries/sandpaper-docs/compare/md-outputs..md-outputs-PR-270

The following changes were observed in the rendered markdown documents:

 component-guide.md | 4 +++-
 md5sum.txt         | 2 +-
 2 files changed, 4 insertions(+), 2 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2026-02-06 13:33:22 +0000

github-actions Bot pushed a commit that referenced this pull request Feb 6, 2026
@froggleston
froggleston merged commit 59599f4 into main Feb 7, 2026
5 checks passed
@froggleston
froggleston deleted the callouts-optional branch February 7, 2026 12:14
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.

2 participants