search

tweag / nickel

Better configuration for less
https://nickel-lang.org/
MIT License
2.42k stars 92 forks source link

Add a cheatsheet to the documentation #1123

Open jlesquembre opened 1 year ago

jlesquembre commented 1 year ago

Is your feature request related to a problem? Please describe.

I have been using Nickel for some months, usually with 1-2 weeks breaks. I'm a bit frustrated that after one of those breaks, I tend to forget about Nickel syntax, especially if I wrote a more complex contract.

Describe the solution you'd like

While everything seems documented in the user manual, I think having a page with an overview of all the operators, types, functions, etc, could be useful for intermediate users. Some kind of cheatsheet / quick reference. As an example, I think the cheatsheet for Clojure is quite good. (I keep consulting it after years writing Clojure)

Related to #1122

yannham commented 1 year ago

That would be nice but not strictly required for 1.0. We might still make it, but removing from a strict requirement for the milestone to be achieved.