Reference style Markdown links for faq.md

pkeilbach / htwg-practical-nlp

A practical course on natural language processing @ HTWG Konstanz.

https://pkeilbach.github.io/htwg-practical-nlp/

8 stars 17 forks source link

Reference style Markdown links for faq.md #145

Open MichalT106 opened 1 month ago

MichalT106 commented 1 month ago

Based on issue #144, I have updated the faq.md markdown file.

The following changes were made:

All external links have been replaced with references at the start of the markdown file.
Links are now in the correct format, improving the readability and maintainability of the markdown document.

These changes ensure a consistent link format in line with the project's requirements.

MichalT106 commented 1 month ago

@pkeilbach I make a pull request #146, for updated faq.md. I apologize for the mess, but I couldn't assign this issue and push it either, I had to create a fork and then a PR.

pkeilbach commented 1 month ago

@MichalT106 no problem, and this is exactly as intended: you will need to fork the repo.

But please wait for the PR until #134 is merged ✌🏼 This PR will also contain the updated contribution guidelines.

you can convert your PR #146 to a draft for now

MichalT106 commented 1 month ago

@pkeilbach more markdowns are related to #134 or only Faq.md ? Because I would like to update more markdowns with #144 and then end it with RP.

pkeilbach commented 1 month ago

@MichalT106 the updates in #134 will affect many markdown files, not only docs/faq.md.

The updates in #134 will contain more details about the contribution process.

We can merge #146 whenever #134 is in, but, to be fair with other students, let's wait with any further contributions until we officially kick off the semester on November 8 ✌🏼

MichalT106 commented 1 month ago

@pkeilbach and are there any markdowns that can be modified and checked immediately with pull request confirmation? School has already started for me and I would need to make a pull request on an open source project. Could you please find some markdowns that can be pulled requested immediately? I would greatly appreciate it, thank you.

pkeilbach commented 1 month ago

@MichalT106 In theory, you could check which markdownfiles are not affected by #134 .

But again: to give everybody the same chance of earning bonus points for the course, we need to wait with contributions until we kick off the course officially on November 8.