Fork me on GitHub
#docs
<
2017-10-03
>
admay13:10:10

I just finished looking around on the Haskell site, https://www.haskell.org/ and it’s, I think, a great example of how to structure a documentation site. Specifically their documentation page, https://www.haskell.org/documentation. It’s a single link to a universal road map, like we were talking about, that’s intuitive to find.

admay13:10:11

Its a great page which, I think, should be the hub for anything documentation and presented on the front page as a “Don’t know where to go? Whatever you’re looking for, you can find it here” kind of thing

Alex Miller (Clojure team)14:10:33

It’s linked on the front page on the right side bar in the Community block

admay14:10:30

As ‘Community’, I’m thinking something like the Community hub for documentation resources would be beneficial. Not necessarily changing the purpose of the Community hub, but creating one for the guides, reference, APIs, etc…

Alex Miller (Clojure team)14:10:15

Right now the main “guides” link just goes to the first guide. It could instead go to an overview page

Alex Miller (Clojure team)14:10:13

or something could do that. I’ve never been entirely happy with the right side bar on the front page

admay14:10:40

The ‘learn more’ side bar?

Alex Miller (Clojure team)14:10:06

yeah - that could be doing more