documentation tweaks

[ijlyttle]

As a "final" step before starting the release process, I want to dedicate a PR to documentation, particularly harmonizing things - either for new functions, or for new thinking.

• check that we are taking care of parameter inheritance
• consistency of version_id and version_no
• update README to highlight new features (Ian)
• update vignette("boxr") as needed (Ian)
• add documentation on uploading to RStudio server/cloud (Clearer guidance on uploading auth to RStudio Server et al. #180) (Nate)
• describe more explicitly the compromise on returning API responses vs. data frames (begin a vignette("design")). (Ian)
• add some words about JWT time-offset in service-apps vignette. (Ian)
• add new functions to pkgdown function-reference (Nate)
• note which functions are superseded and which are deprecated (Nate)
  • add tidyverse tag for superseded/deprecated?
  • make sure we use the newer functions in function docs and articles
  • add Superseded section to function reference (collab() deprecates dir_invite(), history() supersedes prev_versions())
  • update Deprecated section of function reference (remains deprecated box_auth_on_attach(), still in package)
• ensure consistent function-titles and -return values

[nathancday]

Thanks for calling this out, it's super important. I'd be happy to do this over a Zoom or split up the tasks once we say the code changes are done.

[ijlyttle]

That sounds great! Let's get the code changes done, then set up a Zoom call.

[ijlyttle]

Edited list to include:

• documentation on uploading credentials to RStudio Server/Cloud
• make more explicit the compromise of returning API responses instead of data frames.

[nathancday]

Just pushed up several commits, make sure to pull if you are editing anything.