Documentation is not readily navigable in an obvious way

[bford]

Problem 1: The README.md at the top of the tree links to GitHub pages, but that page has just a bare "what is Dela" landing page with no obvious further links to the actual documentation. It looks like this page needs to incorporate or link to 'docs/sidebar.md' or some equivalent, but doesn't yet.

Problem 2: A lot of the "real" detailed API documentation is GoDoc, but there's no obvious link leading to that. It looks to me like the top-level README.md, as well as docs/sidebar.md, should probably offer links to the godocs for detailed API documentation.

[bford]

To update this comment after realizing that the documentation page does actually have documentation but you have to scroll down to get to it... The landing page is pretty but a bit too minimalistic, with no actual visual hint about where one can go from it and how. There are at least two obvious solutions:

• Make the sidebar present throughout the whole vertical page, not just below the landing part. If you want the landing page to have the "bare" look to start with, the sidebar could be closed initially so that only the little navigation button appears in the upper left corner that pops out the sidebar.
• Make the Dela name, logo, and most/all of the text underneath it into a link or button that simply scrolls down to the start of the "real content" below the landing page. Just make sure that clicking just about anywhere does something good, namely getting the user to the real content.

If you want the landing page to have the "bare" look but have the sidebar visible by default when the user starts looking at the "real content" page, then maybe the best thing to do is a combination of the above two points: have the sidebar present on the landing page but closed initially by default (with only the little navigation button appearing in the top left corner) - but then if the user clicks pretty much anywhere on the landing page it both scrolls down to the real content and automatically opens the sidebar at the same time. I'm sure JavaScript can do that. :)

Further, the "Go lint" etc bar could probably be moved to the bottom, or even be moved off the landing page to the first main content page below - I don't see why a reader needs to see Dela's "Go lint" status before they can see anything else about what it is.