box icon indicating copy to clipboard operation
box copied to clipboard

Make individual topics more discoverable in documentation

Open klmr opened this issue 3 years ago • 0 comments

Things like

  • [ ] ‘roxygen2’ documentation
  • [ ] support for testing
  • [ ] support for FFI
  • [ ] module implementation details
    • [ ] imports (lack of attached core R packges, r/core …)
    • [ ] using modules as application entry points (box::name())
    • [ ] Module search path
    • [ ] Export specification
  • [ ] ‘box’ options/environment variables
  • [ ] …

should have individual entries in the documentation index to be more discoverable. Vignettes are great but no substitute for this. Neither is the FAQ, or sections inside the box:use() man page.

See also https://twitter.com/rmflight/status/1526192221720137731.

klmr avatar May 16 '22 13:05 klmr