docs: 📝 update the README file #76
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
signekb
requested changes
Mar 7, 2025
| GitHub is increasingly used as a platform for collaborating and sharing | ||
| research projects, not only for code but for documents. This workshop | ||
| aims to introduce participants to the basics of using GitHub for | ||
| collaboration and version control. The workshop is designed for |
There was a problem hiding this comment.
Is it collaboration though with no branching and PRs/reviews? Is the collaboration referring to commenting on issues?
| workshop administration files. | ||
| This repository mainly contains the workshop material that both the | ||
| participants and instructors use during the workshop. It also includes | ||
| files that build support building the website as well as configurations |
There was a problem hiding this comment.
Suggested change
| files that build support building the website as well as configurations | |
| files that support building the website as well as configurations |
| TODO: Very brief intro, motivation, and overview of workshop. | ||
| GitHub is increasingly used as a platform for collaborating and sharing | ||
| research projects, not only for code but for documents. This workshop | ||
| aims to introduce participants to the basics of using GitHub for |
There was a problem hiding this comment.
In this section the word “participants” is used, while in the latter sections it’s “learners”. Should this be aligned?
| The material in this workshop is designed to be presented primarily with | ||
| a participatory live-"typing" approach. This involves an instructor | ||
| doing the tasks on screen live in front of the learners, while the | ||
| learners follow along using their own computers. Activities to support |
There was a problem hiding this comment.
Suggested change
| learners follow along using their own computers. Activities to support | |
| learners follow along by doing the tasks on their own computers. Activities to support |
| learners follow along using their own computers. Activities to support | ||
| learning are interspersed throughout the workshop material, allowing | ||
| participants to discuss with their neighbours or work on smaller | ||
| problems for a few minutes to reinforce learning. All material are |
There was a problem hiding this comment.
Suggested change
| problems for a few minutes to reinforce learning. All material are | |
| problems to reinforce learning. All material are |
The exercises are (at least set to be) more than a few minutes :)
| repository: | ||
|
|
||
| - `index.Rmd`: Contains the overview of the workshop. This is the | ||
| landing page for the website. |
There was a problem hiding this comment.
Suggested change
| landing page for the website. | |
| landing page of the website. |
| (e.g. code-along material). | ||
| - `appendix/` folder: Contains the files used to support the workshop, | ||
| such as resources and instructions for instructors. | ||
| - `slides/`: The presentation slides used for the workshop. |
There was a problem hiding this comment.
Suggested change
| - `slides/`: The presentation slides used for the workshop. | |
| - `slides/`: Contains the presentation slides used for the workshop. |
| your own would be the slides, however, they are also good enough to use | ||
| on their own too. | ||
| The workshop is largely designed to be taught in the order given, as | ||
| each session builds off of the previous ones. The easiest way to use |
There was a problem hiding this comment.
Suggested change
| each session builds off of the previous ones. The easiest way to use | |
| each session builds off of the previous one(s). The easiest way to use |
Comment on lines
+67
to
+68
| to make as your own would be the slides, however, they are also good | ||
| enough to use on their own too. |
There was a problem hiding this comment.
Suggested change
| to make as your own would be the slides, however, they are also good | |
| enough to use on their own too. | |
| to make as your own would be the slides, however, they can also | |
| be used on their own. |
|
|
||
| But if you want to customize a bit more, the best approach is to [fork | ||
| the repository](TODO) into your own GitLab account and modify it to fit your | ||
| But if you want to customize a bit more, the best approach is to fork |
There was a problem hiding this comment.
Suggested change
| But if you want to customize a bit more, the best approach is to fork | |
| If you want to customize the content a bit more, the best approach is to fork |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updates the README text of the repo.
Closes #41
This PR needs an in-depth review.
Checklist