Brendan Hansknecht (Aug 21 2024 at 00:01): Brendan Hansknecht (Aug 21 2024 at 00:01):The tutorial for Roc lang is really long now. Potentially kinda overwhelmingly so. It also dives into some advanced synctaxes like record builder. Obviously, this format can work (look at the zig docs), but is there a better format that presents less per page. Potentially with a bit more interaction to help with learning one piece at a time. What we have today feels more like a dense reference than a good first tutorial. Any thoughts?
batyoullfly (Aug 21 2024 at 00:11):I think more links in the table of contents would be handy too, because it is a such a dense reference, so finding specific pieces in the tutorial can be tricky
Brendan Hansknecht (Aug 21 2024 at 00:12):Yeah, like how zig does to help deal with the density of information
Luke Boswell (Aug 21 2024 at 01:34):I mentioned this previously... and there was a reason Richard wanted it to be all in one page
Luke Boswell (Aug 21 2024 at 01:34):I don't recall what it was
Luke Boswell (Aug 21 2024 at 01:34):We have discussed developing a Language Reference https://www.roc-lang.org/docs#language-reference
Luke Boswell (Aug 21 2024 at 01:35):There is definitely content in the Tutorial that could/should be moved into a more formal reference. We haven't discussed the details though
Luke Boswell (Aug 21 2024 at 01:36):batyoullfly said:
I think more links in the table of contents would be handy too, because it is a such a dense reference, so finding specific pieces in the tutorial can be tricky
We had a lot more links, and only recently trimmed them down to this. Maybe it was to help with the mobile view.
Luke Boswell (Aug 21 2024 at 01:38):Potentially with a bit more interaction to help with learning one piece at a time.
I'd love to do this. Have a interactive examples in the browser for each step.
Luke Boswell (Aug 21 2024 at 01:40):I think the goal for the Tutorial is a guided tour of the language, and the Language Reference is more like an index documenting the key concepts.
Richard Feldman (Aug 21 2024 at 02:37):yeah I have a wip langref that I haven't turned into a PR yet
Richard Feldman (Aug 21 2024 at 02:38):I want to get that going and then redo the tutorial to focus on building something rather than taking a lot of tangents about language features like the current one does
Last updated: Jun 16 2026 at 16:19 UTC