quarto-dev / quarto-dev/quarto-cli

Add known feature limitations to documentation

Open
#6,161 0 comments 1 reaction 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

Opening this after asking to @cwickham and following https://github.com/quarto-dev/quarto-cli/discussions/6140

We need a good way to add known limitation to docs. Currently we have several patterns I think

Having a common way to document it would ease the discovery I guess.

Ideas:

  • Special common callouts
  • A common sections
  • More subtle using collapse content
  • or even on-hover content if we want to "hide" by default but still be easily findable.

TBD

This issue can also be a recipient to track all limitation to be documented

Known limitations:

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 by reviewing the linked discussion 6140 and the existing “Known limitations” and “Format Support” sections in the referenced documentation pages. Compare the proposed callout, section, collapse, and hover approaches, then define and document one common convention. Done means the convention is agreed and the listed limitations from discussions 6140 and 6187 are tracked or documented.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.