quarto-dev / quarto-dev/quarto-cli
Improve how users find the context of options
Open
@cwickham is already working on this.
Since Apr 13, 2023.
documentation
- Dominant language
- JavaScript
- Stars
- 6k
- Forks
- 458
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 41
Description
From #4936, given the name of an option, e.g. number-sections, it can be hard for a user to understand the context it needs to be used in, e.g. under a format not under book.
It could be:
- This is an educational need, i.e. some explanation somewhere that teaches people how to figure out the right context.
- This is a "Reference" doc improvement, e.g. options have a more explicit link to their context.
- Is the page they occur on (e.g.
number-sectionsis onformats/html.html) sufficient?
- Is the page they occur on (e.g.
- This is a "Guide" doc improvement, e.g. when options are presented context needs to be made more explicit (or there needs to be a way for a user to easily find the context directly from the Guide page).
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.