cage icon indicating copy to clipboard operation
cage copied to clipboard

Add table of contents to wiki homepage

Open slhck opened this issue 1 year ago • 2 comments

This seems like a useful project that I would like to check out, but I could not find any instructions on the website or the wiki.

Apparently GitHub hides the list of pages by default, so it would be good to provide a table of contents on the wiki homepage.

image

Otherwise it's almost impossible to find these other wiki pages.

slhck avatar Jul 18 '22 11:07 slhck

Otherwise it's almost impossible to find these other wiki pages.

Welcome to 2022. Where people claim doing one click on a item in strong font, named PAGES makes it impossible to find the pages..

jubalh avatar Jul 18 '22 12:07 jubalh

Let's say, impossible to find the other pages unless you look around more and know how GitHub wikis work. Trust me, that part was simply not that salient. And even then, the pages are not sorted in a meaningful order (why does configuration come before installation?).

I'd say 95% of all projects I've seen provide the documentation either directly in the README or on a dedicated page with a table of contents. It wouldn't hurt to add one.

(I would have done it myself but the wiki is not publicly editable.)

slhck avatar Jul 18 '22 13:07 slhck