search

rage / secret-project-331

https://courses.mooc.fi/
Apache License 2.0
66 stars 3 forks source link

Move from Wiki to /docs #1287

Open akirataguchi115 opened 4 months ago

akirataguchi115 commented 4 months ago

GitHub Wiki is an anti-pattern for various reasons: https://michaelheap.com/github-wiki-is-an-antipattern/ . As a developer and as a lecturer the Wiki is hard to navigate. At some point it would be a good idea to move to /docs and maybe host it on Pages: https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis

nygrenh commented 2 months ago

We used the GitHub Wiki because we wanted to use the /docs folder only for developer documentation, and we wanted the user documentation to be in a separate location.

The GitHub Wiki is a convenient solution to archive that goal. However, I do agree that the navigation could be improved.