Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use sentence case for setup guides #133

Open
pkeilbach opened this issue Oct 6, 2024 · 3 comments
Open

Use sentence case for setup guides #133

pkeilbach opened this issue Oct 6, 2024 · 3 comments
Labels
good first issue Good for newcomers 🏅 1 bonus point

Comments

@pkeilbach
Copy link
Owner

pkeilbach commented Oct 6, 2024

While writing CONTRIBUTING.md, I noticed that it is more appropriate to use sentence case for the headlines.

The scope of this issue is to update all technical documentation to use sentence case in their headlines, namely:

  • docs/getting_started.md
  • docs/assignments.md
  • docs/presentations.md
  • docs/course_profile.md

Also ensure that with sentence case, the headlines are more descriptive where it makes sense, e.g. here: ## Starting the Jupyter server instead of ## Jupyter

(Note that Jupyter is still capitalized in sentence case because it is a proper noun)

@pkeilbach pkeilbach added the good first issue Good for newcomers label Oct 6, 2024
@browo097302
Copy link

Hi, I'm happy to help with this, could I be assigned for this issue?

@pkeilbach
Copy link
Owner Author

Awesome, @browo097302 , I will assign you to the issue!

Maybe you can wait a bit with the implementation until I finish the preparations for the semester 👉🏼 #134

Also to be fair with the other students before we kick off the semester officially. ✌🏼

@browo097302
Copy link

Great, thanks will do

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers 🏅 1 bonus point
Projects
None yet
Development

No branches or pull requests

2 participants