I don't know what @bbolker would say, I've tried to follow the pkgdown conventions for the Reference page and think for more specific high-bandwidth stuff a vignette is a good way to go, and my opinion is that the detail on the shellpipes landing page is probably pretty good for now. https://pkgdown.r-lib.org/articles/pkgdown.html#reference
Right now the landing page https://dushoff.github.io/shellpipes/ (edit here: https://github.com/dushoff/shellpipes/blob/main/index.md) asks "(BB: feel free to tell me what’s the recommended way to put documentation online)."
I don't know what @bbolker would say, I've tried to follow the pkgdown conventions for the Reference page and think for more specific high-bandwidth stuff a vignette is a good way to go, and my opinion is that the detail on the shellpipes landing page is probably pretty good for now. https://pkgdown.r-lib.org/articles/pkgdown.html#reference