redwoodjs-com-archive icon indicating copy to clipboard operation
redwoodjs-com-archive copied to clipboard

Documentation Idea: Cheatsheets

Open dthyresson opened this issue 5 years ago • 1 comments

Whenever I have to write some r and venture into RStudio, I keep going back to these cheatsheets:

https://rstudio.com/resources/cheatsheets/

For example:

image

They even provide templates if you want to contribute your own (and many in the community have):

https://rstudio.com/resources/cheatsheets/how-to-contribute-a-cheatsheet/

I've been following the "Quick Start" issue, but for me the quickest start is to open up one of these sheets to answer:

  • how do I change the dev server port
  • how to a set the param in a beforeQuery cell
  • what are the serve generator options
  • how do i deploy to netlify

I could see several cheat sheets per package or topic.

dthyresson avatar Oct 14 '20 13:10 dthyresson

I wrote a community post suggesting a cheat sheet back in August, and created a first draft that was organized similarly to the way the docs were structured at the time.

  • Web configuration
  • API configuration
  • Browser target configuration
  • CLI Commands
  • Form Components
  • Redwood Router
  • Webpack Configuration

It just uses tables in markdown to provide a brief description which I think would be a low barrier of entry for adding to it.

ajcwebdev avatar Oct 16 '20 07:10 ajcwebdev