rstudio / helm

Helm Resources for RStudio Products
MIT License
36 stars 28 forks source link

Add /docs readme for updating and contributing to the Helm docs #505

Open AshleyHenry15 opened 6 months ago

AshleyHenry15 commented 6 months ago

It isn't clear what files actually "do the editing" for the Helm docs.

Probably should add to the readme that to edit the docs for Workbench, Connect, PPM, and Chronicle Overview pages, it requires a combo update of the following:

And to preview changes:

quarto preview --render html

In addition, we should also add how to edit the Examples doc for each product as well.

### Tasks
- [ ] It also wasn't clear that I needed to install `helm-docs` and run `just setup`