Skip to content

Update project documentation#514

Open
anenadic wants to merge 4 commits intomainfrom
project-documentation
Open

Update project documentation#514
anenadic wants to merge 4 commits intomainfrom
project-documentation

Conversation

@anenadic
Copy link
Collaborator

Fixes #506.

@anenadic anenadic requested a review from steve-crouch January 27, 2026 13:40
@github-actions
Copy link

github-actions bot commented Jan 27, 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/carpentries-incubator/python-intermediate-development/compare/md-outputs..md-outputs-PR-514

The following changes were observed in the rendered markdown documents:

 GOVERNANCE.md | 81 ++++++++++++++++++-----------------------------------------
 md5sum.txt    |  2 +-
 2 files changed, 26 insertions(+), 57 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-01-27 13:42:17 +0000

github-actions bot pushed a commit that referenced this pull request Jan 27, 2026
Copy link
Collaborator

@douglowe douglowe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me.

I have made one comment about adding a note about the CITATION.cff file being our single point of truth - but I don't know if we need this here, so dismiss the comment if you disagree.


Contributors of more significant changes to the lesson may be invited by the Maintainers to add themselves to the
Authors list.
Contributors of more significant changes to the lesson may be invited by the Maintainers to add themselves to the Authors list and CITATION.cff.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a note here that the CITATION.cff file is our source of truth for authors?

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.

Updating project documentation

2 participants