Stream: beginners

Topic: What is the most up-to-date documentation source?


view this post on Zulip Peter Marreck (Sep 20 2024 at 14:52):

Is it the tutorial and/or the docs section? Is it more or less kept up-to-date? (I know it can fall behind, especially on embryonic-level projects like this, no judgment implied, just wondering!)
I'd love a single document (like a markdown ideally) that I could just read through. The tutorial is close.

view this post on Zulip Brendan Hansknecht (Sep 20 2024 at 17:33):

For the language or the compiler?

view this post on Zulip Brendan Hansknecht (Sep 20 2024 at 17:34):

Anyway for the language and core platforms, tutorial and autogenerated docs are generally up to date.

view this post on Zulip Brendan Hansknecht (Sep 20 2024 at 17:35):

https://www.roc-lang.org/tutorial
https://www.roc-lang.org/builtins

view this post on Zulip Brendan Hansknecht (Sep 20 2024 at 17:35):

https://www.roc-lang.org/packages/basic-cli
https://www.roc-lang.org/packages/basic-webserver

view this post on Zulip Anton (Sep 21 2024 at 08:28):

The examples in the docs or tutorial can not be easily tested yet so it's possible we forgot to update some, feel free to raise issues if you find code that doesn't work.

view this post on Zulip Peter Marreck (Sep 21 2024 at 10:55):

@Brendan Hansknecht Is there any way to autogenerate a markdown instead of the live-searchable web UI?

view this post on Zulip Anton (Sep 21 2024 at 15:31):

Not yet, I expect that will come with #7077, can you share why you want that format?

view this post on Zulip Peter Marreck (Oct 01 2024 at 22:12):

Anton said:

Not yet, I expect that will come with #7077, can you share why you want that format?

@Anton
That ticket guessed it, more or less. I wanted (among other things) to be able to provide the latest syntax details to an LLM for code assistance due to their usually-outdated cutoff dates.

I also had an idea for a commandline help function that basically filtered down as you typed (similar to fzf), but also would prefer a markdown format for piping to something like charmbracelet/glow


Last updated: Jul 05 2025 at 12:14 UTC