Update documentation following discussion quarto-dev/quarto-cli#439

Author: cderv

examples/example-04-other-workflows.md

@@ -7,4 +7,13 @@ If you need to render your project in a GitHub Action, but will use the output f
 ```yaml
 - name: Render Quarto Project
   uses: quarto-dev/quarto-actions/render@v2
-```
+```
+
+Use also this action if you need to render to a specific format that you want to publish (`quarto publish` will render to all format before publishing unless `--no-render` is passed).
+
+```yaml
+- name: Render Quarto Project
+  uses: quarto-dev/quarto-actions/render@v2
+  with:
+    to: html
+```

examples/example-06-no-render.md

@@ -13,3 +13,24 @@ to the `publish` action:
     render: false
 ```
 
+## Chaining render then publish
+
+By default, `quarto publish` will render to all format defined before publishing.  
+If you need to customize the rendering step, e.g only render one format in CI before publishing, use a two step process: 
+
+* `quarto render` by providing the targer output format
+* `quarto publish --no-render` to skip re-rendering before publishing
+
+```yaml
+- name: Render Book project
+  uses: quarto-dev/quarto-actions/render@v2
+  with:
+    to: html
+
+- name: Publish HTML book
+    uses: quarto-dev/quarto-actions/publish@v2
+  with:
+    target: gh-pages
+    render: false
+    path: ${{ env.QUARTO_OUTPUT }} # define this env var if you are using a non default output-dir
+```

publish/README.md

@@ -55,5 +55,9 @@ Give this token a memorable name, and note the resulting string (or keep this wi
        CONNECT_API_KEY: ${{ secrets.CONNECT_API_KEY }} 
    ```
 
+## Other configurations
 
+The `with` parameter can also be set to configure the following
 
+* `path`: Subdirectory containing the quarto project to be published. Default to working directory (`.`)
+* `render`: Set to `render: "false"` to skip rendering of project before publishing. By default, this `publish` action will render to all formats defined.

render/README.md

@@ -0,0 +1,9 @@
+# Usage
+
+```yaml
+- name: Render Quarto Project
+  uses: quarto-dev/quarto-actions/render@v2
+  with:
+    to: html # If set, it will be equivalent to `quarto render --to html`
+    path: source-folder # By default, the current working dir is used i.e `quarto render .`
+```