Stream: beginners

Topic: ✔ docs command

Takeshi Sato (Nov 03 2021 at 07:36):

How do I use docs command?
If I run roc docs inside examples/hello-world/ directory, generated-docs is generated.
But this directory does not have root index.html. Does this work correctly? or is docs under developing?

generated-docs/
├── Effect
│   └── index.html
├── favicon.svg
├── search.js
└── styles.css

Anton (Nov 03 2021 at 08:24):

Yes, the docs are still a work in progress, I'll make sure to include this in the CLI help.

Takeshi Sato (Nov 03 2021 at 10:26):

Thanks!
I just expected that this doc command might be useful for me to learn some basic knowledge of roc. (I'm a beginner)
So I will revisit in the future.

Richard Feldman (Nov 03 2021 at 11:41):

I'm working on writing up a tutorial on how the language works...hoping to be done with it later in November! :big_smile:

Notification Bot (Nov 10 2021 at 11:13):

Takeshi Sato has marked this topic as resolved.

Paul Sutcliffe (Nov 10 2021 at 14:43):

Can I give you a hand with a tutorial?

Richard Feldman (Nov 10 2021 at 15:29):

I'd like to do a first draft myself, but I'd love feedback on it once it's at that point!

David K (Nov 11 2021 at 09:00):

Don't know if this is in the same category, but I really liked roc-for-elm-programmers, would be nice to have similar files for other languages. I'm happy write up the c++ one once I get a little more used to Roc.

Lucas Rosa (Nov 11 2021 at 22:10):

good idea

Brendan Hansknecht (Nov 11 2021 at 23:18):

We may want to try and make it more generic so we don't end up adding 1 for many many languages. So maybe instead of just C++ focused, maybe focus on the C syntax style languages (C, C++, C#, Java, etc). Though I guess we could make many of these guides and just throw them all in a folder.

Lucas Rosa (Nov 11 2021 at 23:50):

Roc for Imperative Programmers @Brendan Hansknecht

Last updated: Jul 06 2025 at 12:14 UTC