Stream: contributing

Topic: language reference


view this post on Zulip Richard Feldman (Dec 21 2025 at 18:13):

I'm starting on writing a full language reference - can anyone think of anything this list is missing?

view this post on Zulip Richard Feldman (Dec 21 2025 at 18:14):

the langref assumes the reader already generally knows how to program in Roc, but is looking for a detailed explanation of how each of its parts work.

it intentionally doesn't include sections on builtin types like Str, List, etc. because those have their own documentation and it's better to have that information centralized in one place than split between the builtin docs and the language reference.

view this post on Zulip Richard Feldman (Dec 21 2025 at 18:15):

the goal is to make things highly linkable, in case there's a discussion and someone wants to point to a relevant detail about the language that someone else in the discussion might not know

view this post on Zulip Jared Ramirez (Dec 21 2025 at 18:56):

i think opaque vs transparent nominal types is missing!

view this post on Zulip Brendan Hansknecht (Dec 21 2025 at 21:22):

Looks good to me

view this post on Zulip Richard Feldman (Dec 22 2025 at 00:25):

as I'm writing this I am finding a strong urge to call it Rocipedia :grinning_face_with_smiling_eyes:

view this post on Zulip Luke Boswell (Dec 22 2025 at 01:53):

I think it should be called "The Roc Anthology" :rock_on: :guitar:

view this post on Zulip nandi (Dec 23 2025 at 07:45):

Richard Feldman said:

it intentionally doesn't include sections on builtin types like Str, List, etc. because those have their own documentation and it's better to have that information centralized in one place than split between the builtin docs and the language reference.

Where can I find the docs for those types in new compiler? I found stuff like https://github.com/roc-lang/roc/blob/13926dfdd3fe1d6d811d11984d6a692feaf60823/src/builtins/list.zig is that the docs?

view this post on Zulip Fabian Schmalzried (Dec 23 2025 at 07:51):

Currently https://github.com/roc-lang/roc/blob/main/src%2Fbuild%2Froc%2FBuiltin.roc is the best we have.

view this post on Zulip nandi (Dec 23 2025 at 08:14):

I also found stuff like https://github.com/roc-lang/roc/blob/13926dfdd3fe1d6d811d11984d6a692feaf60823/test/snapshots/repl/list_get.md


Last updated: Jan 12 2026 at 12:19 UTC