[libre-riscv-dev] wiki usability issues
programmerjake at gmail.com
Mon Jun 17 10:10:20 BST 2019
the libre-riscv wiki needs to have the css modified to remove the dotted
line on the right side of the screen, it interferes with wide tables.
also, pages are nearly impossible to find on the wiki without using google
or some other search engine.
If I can't find pages and I'm one of the main project contributors, that
makes other people much less likely to be able to find much.
if ikiwiki has the functionality, it needs to be enabled:
1. wiki-wide search (either built in or link to google site-search or
2. an index page with a link from the main page
3. each page to have autogenerated links to subpages under them, like a
table of contents. only the direct subpages need to be listed, indirect
subpages can be left out (though listing all subpages, direct or indirect
would probably be a good idea if it's not too long).
item 3 can replace item 2, but it's necessary to have either 1 and 3 or 1
and a autogenerated table of contents that's linked to on every page.
if ikiwiki doesn't have a way to automatically link subpages or some other
method to improve discoverability, then I think we should seriously
consider switching to a different documentation system, since we currently
have the additional drawback of the wiki needing to be edited through
cloning the git repo and people explicitly being given push permissions.
If we do need to change, I recommend linking to the wiki functionality in
debian salsa, and just having a static html page for the main
libre-riscv.org website that just links to salsa for the docs.
More information about the libre-riscv-dev