idris-lang / Idris2

A purely functional programming language with first class types
https://idris-lang.org/
Other
2.49k stars 373 forks source link

Wiki documentation seems outdated #2603

Open ribosomerocker opened 2 years ago

ribosomerocker commented 2 years ago

Specifically, in the wiki's "State of Idris 2 documentation" "documentation we wish we had" section, you mention that you wish you had:

a FAQ a tutorial on quantities a tutorial for how to use the REPL and it's commands

for the first two, i believe that

are perfect as they are. But for the third one, I think it does need work, but there's already a fairly decent base at https://idris.readthedocs.io/en/latest/reference/repl.html, it just needs to be updated.

furthermore, in the community i've seen links like

exchanged around, which would certainly be really useful to have on the idris2.readthedocs.io page and also here on the wiki. also, it would be nice to have a separate issue template for documentation and a tag for it too, as that's a very important part in my opinion.

andrevidela commented 2 years ago

Thank you for pointing this out. The wiki is free to modify, would you (or someone else) be willing to perform the necessary updates?

ribosomerocker commented 2 years ago

Yes. I wanted to do this way earlier, but I just didn't have the time. I'll get to it soon, though the one part I can't do is add a "documentation" issue template. I was also trying to get some more suggestions on the Discord server, though I haven't been very successful with that.

joelberkeley commented 2 years ago

I've added those last two links to the wiki and mentioned the first links in the wiki discussion

I do think there are more things that need adding to FAQs - a number of questions raised frequently on discord aren't in there