Skip to content

Update and tidy up Instructor Notes#202

Open
alex-ball wants to merge 3 commits intoLibraryCarpentry:mainfrom
alex-ball:patch-1
Open

Update and tidy up Instructor Notes#202
alex-ball wants to merge 3 commits intoLibraryCarpentry:mainfrom
alex-ball:patch-1

Conversation

@alex-ball
Copy link
Copy Markdown
Contributor

@alex-ball alex-ball commented Mar 31, 2026

This PR tackles a set of issues with the Instructor Notes page:

  • Removes unnecessary horizontal lines and <h1> headings, and tweaks the order to match better with the (very similar) Software Carpentry git-novice Instructor Notes.
  • Updates the outdated links.
  • Replaces link texts that are unsatisfactory from an accessibility standpoint (URLs, "this") with more specific and descriptive texts.
  • Rewords the paragraph on line endings for a more logical flow, and adds the tip from Software Carpentry for resetting working directories with mixed line endings.

Some links were outdated, and some link texts went against good
practice for accessibility (using the URL or obscure phrases like
"this" or "this page").

I have also reworded the point about whitespace differences to make it
a bit more logical.
With the current template, <h1> and <hr> elements don't work well.

These changes bring the page more in line with swcarpentry/git-novice.
The new text comes from swcarpentry/git-novice.
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 31, 2026

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/LibraryCarpentry/lc-git/compare/md-outputs..md-outputs-PR-202

The following changes were observed in the rendered markdown documents:

 instructor-notes.md | 60 ++++++++++++++++++++++-------------------------------
 md5sum.txt          |  2 +-
 2 files changed, 26 insertions(+), 36 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-31 10:43:43 +0000

github-actions bot pushed a commit that referenced this pull request Mar 31, 2026
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