aelve / guide

A workspace for research teams
https://guide.aelve.com
106 stars 10 forks source link

Make Guide better as a resource for people who are toying with Haskell and randomly google stuff #149

Closed neongreen closed 5 years ago

neongreen commented 7 years ago

I just tried Elm (nothing too complicated, just wanted to make a POST request to get a token and then use the obtained token to GET a list of strings).

It wasn't a pleasant experience – not because of the language, but because of the docs. Specifically:

However, there were some nice things as well:

So, I want the following things in Guide:

  1. Linked identifiers in Haskell code blocks. No idea yet how to achieve this.

  2. A mechanism for adding popups in Markdown – you click a dotted word, you get a popup. I'm not sure about it, but I think that it will make notes more accessible for beginners – the main text provides information, the popups provide explanations when needed without cluttering the main text. This would have to be tested, though, because there's a chance it would do more harm than good.

  3. Notes should use tabs (will add a sketch later). This will both solve the “can't edit one section” problem and let us pack more info into notes.

  4. I want some kind of “example wizard”. For instance, there's a basic example – “how to make a request” – and then there'd be buttons like “show me how to make a JSON request”, “show me how to make a request with headers”, etc, and added/changed lines would be highlighted. Again, this lets us pack more info into examples. See #150

Maybe there's more.

neongreen commented 7 years ago

Also I want linked identifiers to have popups as well, like here: http://cljs.info/cheatsheet/