Michał Łępicki (Oct 16 2022 at 10:06): Michał Łępicki (Oct 16 2022 at 10:06):I just found (by guessing the URL, I don't think that's mentioned anywhere) that example platforms documentation is available on the website! E.g. File :eyes:
Luke Boswell (Oct 16 2022 at 10:28):Thank you , I didn't know that. You can use roc docs ./*.roc in the platform folder to generate the static files manually. They will be placed into. new folder ./generated-docs.
Anton (Oct 17 2022 at 07:44):Even I didn't know that :p
I'll link it somewhere in the repo
Notification Bot (Oct 17 2022 at 08:58):Michał Łępicki has marked this topic as resolved.
Anton (Oct 17 2022 at 09:43):Turns out that this is already linked in https://github.com/roc-lang/roc/blob/main/examples/cli/README.md
Do you have any suggestions to improve discoverability?
Michał Łępicki (Oct 17 2022 at 10:13):Good to know, thanks! I didn't even see there's a readme there - too many of documents to keep track of, and this one is not linked anywhere. If that helps, I started with reading the Tutorial, then installation/getting started, then running examples as described in examples readme. Then I set up my first project using the cli-platform and somehow missed this one more readme file
Anton (Oct 17 2022 at 10:26):my-first-roc-project.md might be a good new document with tips that we can link to in several places.
Last updated: Jul 06 2025 at 12:14 UTC