More version-control-friendly markdown formatting

[marcodallavecchia]

As we were checking the CONTRIBUTING.md file in #33, I noticed that many lines in that file were simply broken up in many lines: i.e. one paragraph was broken across many lines.

While this might help with reading and editing the content, I don't think it is version-control friendly as it creates a lot of additional lines that makes it difficult to work with when using git. I then realized this problem was present in many more files.

This PR updates all markdown files I could find (as part of the episodes or not) that had this issue, and joined the lines together. For example, we went from this:

This is one
full sentence, but
it's broken across lines

to this:

This is one sentence, but it's broken across lines

[github-actions]

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-incubator/bioimage-analysis-python/compare/md-outputs..md-outputs-PR-35

The following changes were observed in the rendered markdown documents:

 01-introduction.md   |  78 ++----
 02-image-basics.md   | 694 +++++++++------------------------------------------
 03-reading-images.md | 264 ++++----------------
 05-preprocessing.md  |   1 -
 07-postprocessing.md | 383 ++++------------------------
 10-challenges.md     |  66 ++---
 discuss.md           |  33 +--
 edge-detection.md    | 290 ++++-----------------
 index.md             |   7 +-
 instructor-notes.md  |  15 +-
 md5sum.txt           |  24 +-
 prereqs.md           |  11 +-
 setup.md             |  46 +---
 13 files changed, 333 insertions(+), 1579 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-03-29 17:02:15 +0000

[terezbelinova]

Hi Marco, looks great, thanks a lot for the effort. I went through the rendered documentation and all seems fine