I'm coming round to the view that optimum documentation is one web page per function.
This gives you space for prose, examples, related functions, version history and even user comments!
It's not the norm though, and requires substantial content writing.
miniblog.
Related Posts
I'm exploring how I show lists in my documentation. I like boxes for tidiness, but it's much less space efficient. Which do you prefer?
I should also survey how other sites handle this.
When talking about a match or a switch statement, I've typically seen people talk about individual 'cases' or 'arms'.
TIL Zig uses 'prongs' instead!
I'm trying to decide the best voice for PL documentation.
Passive: "`let` can be used with destructuring."
Reader focused: "You can use `let` with destructuring."
Describing the PL: "FooLang supports destructuring with `let`."
Anyone have opinions or best practices?