Docs

[booniepepper]

Create issues for each of these:

• Start an mdBook-based user guide #25
• Write a tutorial!
• Flesh out the user guide (Make more issues?)
• Start/open a wiki for people to share usage notes #47
• Sort definitions in the generated stdlib usage docs #17
• Write a man page #48

[dantecatalfamo]

How many arguments do the functions from the standard library take? Most of the word signatures have the type ( -- ), but my understanding is that the forth word notation lists the things taken off of the stack before the double dash and then the things added to the stack after the double dash.

[dantecatalfamo]

Oh I see they're defined in src/builtins.zig, the notation is just missing on the https://dt.plumbing/stdlib.html page

[booniepepper]

Thanks for taking a look!

On the subject of stack effects...

I need to make sure it's being rendered well, and also explain the stack effect syntax

Also just generally think through how to represent "do" and friends, which can have arbitrary effects

[booniepepper]

Oh... I didn't html-escape elements like <a>!

[booniepepper]

Taking shape little-by-little at https://dt.plumbing/user-guide/

[booniepepper]

I'm pretty good with where the user guide is at now. It's still early but it's enough for someone to make sense of the basics.

Opened issues for the points that were left un-done.