quarto-dev / quarto-dev/quarto-cli
Clean up Shiny docs (R and Python)
@cwickham is already working on this.
Since Dec 12, 2023.
- Dominant language
- JavaScript
- Stars
- 6k
- Forks
- 458
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 41
Description
Shiny for Python docs currently live under Guide > Dashboards > Interactivity > Shiny for Python
Shiny for R docs mostly live under Guide > Interactivity > Shiny (i.e. not under Dashboards, although some pages are included in both locations Guide > Dashboards, and Guide > Interactivity).
This currently leads to confusion:
- Navigating to Guide > Interactivity > Shiny > Running Documents, drops you into the Dashboard docs
- Shiny for Python isn't mentioned in Guide > Interactivity
Some questions to consider:
-
How do "Guide > Interactivity" and "Guide > Dashboards > Interactivity" differ? Do we need both? What content can be shared? How should they be linked? What distinctions do we want to outline for users?
-
Do we still need Component Layout https://quarto.org/docs/interactive/layout.html ? I think this page should focus on the layout of components in longer form articles, and link to dashboards for full page layouts.
-
Where do we talk about the difference between a Quarto dashboard with Shiny Python, and a Shiny Python app (ditto for R): no
server()function, no ui layout functions e.g.ui.page_fluid()etc, no call toApp(), no@outputdecorator (python), adding#| context: server(R)? Some mentions in various places, but it would be nice to have some side by side comparisons of code.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.