Skip to content

Conversation

@alex-ball
Copy link
Contributor

This PR addresses some of the issues with the resources listed in learners/reference.md:

  • It moves the diverse collection of git repositories to after the list of further reading into using git, as I think that makes a more logical progression.

  • It moves the Code4Lib 2008 slides to the further reading section (it is not an example of a GitHub repository);

  • It moves the Programming Historian collection of lessons to the Git repositories section (it is an example of a git repository and GitHub Pages site, but only one of its 117 lessons is further reading about Git).

  • Some of the git repositories are listed as bare links, with no hint of their library or lesson relevance apart from the name, and some of the links in the git repository section are links to rendered resources where you have to do some detective work to find the actual git repository where it is maintained. In this proposal, each GitHub (or GitLab) repository is presented in the following format:

    • Link to repository: Description of resource.
      • Rendered or visualized version: Link

I have not added or removed any resources, and I have left alone the question of whether the resources in each list could be placed in a better order.

Closes #187.

All entries now consist of a link to the repository,  a description, and where applicable a list of related non-Git links (usually a rendering of the source code). This should make it easier to compare the Git-controlled source with the end product in each case.

Relates to LibraryCarpentry#187.
I think the progression from a quick reference for Git, to manuals and tutorials for Git, to examples of Git being used in the wild, is more logical: that way, the scope broadens out the further down the page you go.

Relates to LibraryCarpentry#187.
@github-actions
Copy link

github-actions bot commented Nov 20, 2025

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-193

The following changes were observed in the rendered markdown documents:

 md5sum.txt   |  2 +-
 reference.md | 47 +++++++++++++++++++++++++++--------------------
 2 files changed, 28 insertions(+), 21 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 2025-11-20 17:07:10 +0000

github-actions bot pushed a commit that referenced this pull request Nov 20, 2025
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.

Clarify purpose and content of "Useful library GitHub repositories"

2 participants