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

Move from Wiki to /docs #1287

Open
akirataguchi115 opened this issue Jun 14, 2024 · 1 comment
Open

Move from Wiki to /docs #1287

akirataguchi115 opened this issue Jun 14, 2024 · 1 comment

Comments

@akirataguchi115
Copy link
Contributor

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
Copy link
Member

nygrenh commented Jul 29, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants