docs icon indicating copy to clipboard operation
docs copied to clipboard

Stacks.js and stacks.js.org in need of more thorough reference documentation (argument signatures, type explanations, etc.)

Open mefrem opened this issue 2 years ago • 1 comments

Gold standard: reference docs that lists out functions, the function description, and the different parameters to be passed, and what to do with each parameter and what it does

Problem: People will find the relevant function for their desired functionality, but then have to guess and check with individual parameters the end result.

more notes to be added

mefrem avatar Sep 29 '23 15:09 mefrem

A feedback from dev:

Another suggestion is to add example under every function in stack.js / it you have a little snippet you can reuse it will simplify the docs.

sabbyanandan avatar Feb 13 '24 21:02 sabbyanandan

closing: this is currently being updated in v2 docs

ryanwaits avatar Jul 01 '24 13:07 ryanwaits