quarto-dev / quarto-dev/quarto-cli

confusing source / output pairing

Open
#13,638 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

What would you like to do?

Report an issue on quarto.org

Description

Throughout the documentation of dashboards, theres a persistent pattern of providing source and output that don't match.

For example:

https://quarto.org/docs/dashboards/inputs.html#toolbars

I'd guess this was for the sake of brevity: regurgitating the full Penguins source might obscure the lesson on Toolbars. The effect for me, though, is a very squishy understanding after reading a section of these docs: it's difficult to see what the provided source actually does. Even here, the source has the title "Toolbar" but it's clear the output does not. I think I'd have a firmer understanding if the example were simplified as much as possible, but the actual source provided, but then maybe add line annotations or highlighting to draw attention to the lesson at hand.

This is a genuinely tough bit of documentation to write (should inputs go before interactivity? Should cards go before or after or with data displays?), so I commend your work so far!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the dashboard documentation section at https://quarto.org/docs/dashboards/inputs.html#toolbars and inspect how each source example relates to its displayed output. Done means the examples are simplified or annotated so their source and output clearly match the lesson being taught, while preserving the intended dashboard guidance.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.