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

Add Introduction to Readme #8

Open
oleima opened this issue Oct 23, 2024 · 0 comments
Open

Add Introduction to Readme #8

oleima opened this issue Oct 23, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@oleima
Copy link
Collaborator

oleima commented Oct 23, 2024

Is your feature request related to a problem? Please describe.
There should exist a Introduction section in the Readme. Using this markdown guide to create the section, it can look nice too.

Describe the solution you'd like
A heading level 2 with the text Introduction and then a short description in normal text shortly describing that this is a repo aiming to write a book hosted in GitHub Pages.

Describe alternatives you've considered
Use the guide provided, ask for help from the workshop presenters, or any source to learn basic markdown.

Additional context
This change must be done in a seperate branch, and merged via pull requests. Acceptance criteria is that there is correct markdown heading 2 containing the word Introduction and that there is a simple explanation in normal text below. Do this with a friend if you are unsure, or attempt to solve it by yourself.

@oleima oleima added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Oct 23, 2024
@MOJOliciousFTW MOJOliciousFTW moved this from Backlog to Ready in Workshop 2024 Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
Status: Ready
Development

No branches or pull requests

1 participant