Stream: contributing

Topic: Generating Docs locally

view this post on Zulip Fábio Beirão (May 31 2023 at 11:19):

Is cargo run docs crates/compiler/builtins/roc (after running nix develop) still the correct way to build the docs locally? I am running into this issue, so I'm trying to wonder if there is something wrong with my setup, or if perhaps the command has changed but CONTRIBUTING.md hasn't been updated:

~/git/roc-lang/roc$ cargo run docs crates/compiler/builtins/roc
    Finished dev [unoptimized + debuginfo] target(s) in 0.37s
     Running `target/debug/roc docs crates/compiler/builtins/roc`
── FILE PROBLEM ────────────────────────────────────────────────── UNKNOWN.roc ─

I tried to read this file:

    crates/compiler/builtins/roc

But ran into:

    is a directory

(branch main, Windows WSL Ubuntu 22.04.2 LTS). Thanks :pray:

view this post on Zulip Fábio Beirão (May 31 2023 at 11:33):

In build.sh I see the usage of cargo run --release --bin roc-docs crates/compiler/builtins/roc/main.roc so I'll try that for now as a workaround

view this post on Zulip Anton (May 31 2023 at 12:10):

I've made a PR where the command is updated to use the main file

Last updated: Jul 06 2025 at 12:14 UTC