You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
But when going to the subpage the sections become:
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.
The text was updated successfully, but these errors were encountered:
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:
But when going to the subpage the sections become:
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.
The text was updated successfully, but these errors were encountered: