1
1
mirror of https://github.com/aelve/guide.git synced 2024-12-25 22:02:58 +03:00
guide/static/help.md
2016-03-16 00:31:14 +03:00

1.4 KiB
Raw Blame History

You can edit everything, without registration. (But if you delete everything, I'll roll it back and then make a voodoo doll of you and stick some needles into it).

The most important rule is: it's collaborative notes, not Wikipedia. In other words, incomplete entries like this are welcome here:

pros: pretty nice API
cons: buggy (see an example on my Github, here's the link)

Markdown is supported in most places. 2 noteworthy features: you can write [pkg](@hackage) to get a link to package pkg on Hackage, and you can mark snippets of code with repl to show that they come from GHCi:

~~~ hs repl
> 2+2
4
~~~

Some additional guidelines/observations/etc that probably make sense:

  • sort pros/cons by importance

  • a library can be in several categories list only pros/cons and examples that are relevant to the category

  • don't write about a library if it's worse than all other libraries and doesn't have anything that could make it the preferred choice in some situation

  • if you don't like something for any reason, edit it

  • if you're unsure about something, still write it (just warn others that you're unsure)

  • if you have useful information of any kind that doesn't fit, add it to the category notes

Finally, all content here is licensed under CC BY-SA 3.0 (it's the same license as on Wikipedia and Stackoverflow).