search

roc-lang / roc

A fast, friendly, functional language.
https://roc-lang.org
Universal Permissive License v1.0
4.31k stars 309 forks source link

limited access to web based standard library documentation. #5314

Open human154 opened 1 year ago

human154 commented 1 year ago

It's possible to reach specific parts of the standard library documentation, for example: https://www.roc-lang.org/builtins/Str

However the link to the main documentation section is dead: https://www.roc-lang.org/builtins/Documentation

Currently there are no links from the main web page to the web based documentation.

lukewilliamboswell commented 1 year ago

The main issue that is blocking this is describe in roc-lang/basic-cli#22.

In the interim I have a PR #28 which you can checkout and then follow the instructions in README to generate docs locally.

Basically, 

roc docs src/main.roc
cd generated-docs
simple-http-server --nocache # You can install it with `cargo install simple-http-server`.

Intent is for the docs to be available on the website, but I think this bug breaks CI. So I assume this means that any docs need to be manually generated and uploaded for now which is difficult to support.