Documentation Organization and Presentation in the Navigation

[tothambrus11]

Hylodoc generates a page for each public code entity, source file, folder and article file. There are many ways in which we can present and organize these on the website, the simplest one being a directory structure of the files within the module, and this is what has been implemented.

This is probably not the optimal organization for everybody, and we need to consider the use cases in which people are using the documentation, and possibly provide multiple different views.

For example, the Go package documentation website shows a short overview article (e.g. readme.md), then code symbols categorized as Types, Functions, Constants, Variables, and finally, they also provide two other views: source files (flat list), and directories, which is similar to our current sidebar, and our plan for showing folder contents in folder pages. https://pkg.go.dev/github.com/go-chi/jwtauth/v5#New

Another resource to review is the Swift DocC documentation organization guide: https://developer.apple.com/documentation/xcode/adding-structure-to-your-documentation-pages

If you have any ideas regarding UX, presentation or a specific use case, let's discuss them here. :)