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

Moving wiki pages into /documention/wiki? #442

Open
bluenote10 opened this issue May 21, 2020 · 0 comments
Open

Moving wiki pages into /documention/wiki? #442

bluenote10 opened this issue May 21, 2020 · 0 comments

Comments

@bluenote10
Copy link
Contributor

To close #20 I wanted to improve the documentation in the wiki pages a little bit, which is unfortunately not possible for contributors. This is a famous issue of GitHub isaacs/github#846 with no really good solutions so far.

A common thing I have seen is to move documentation entirely into the repository, which was also suggested in #408. This typically works just as well, since markdown readmes can be linked, and often avoids the tendency of GitHub wiki pages to become outdated, because they can't be edited easily.

What do you think about to make it easier for contributors to improve the documentation?


The motivation for this is that I got confused by the wiki pages a little bit. With the current structure, information feels a bit scattered. In total I'm counting 8 pages that contain build relevant information, and there are some inconsistencies. For instance: The "advanced way" subsections in the overview are:

image

But when going to the subpage the sections become:

image

and the install instruction actually appear several times.

Maybe a single "build instructions" readme would be less likely to become inconsistent, and easier to grasp for users.

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

1 participant