rstudio / rstudio/bslib

Feedback on Filling Layouts article

Open
#919 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
SCSS
Stars
569
Forks
72
Avg merge
1d 2h
Merged PRs (30d)
5

Description

Really cool package. I will be using this package for a dashboard, so I was reading the vignette on filling layouts and had one piece of feedback. I just discovered that the blue containers in the In theory section contains a tooltip when you hover over them. As a first-time reader, it wasn't terribly obvious what these blue containers were until I hovered my mouse over them. It would be helpful if you mentioned somewhere to readers to hover over them.

Screenshot 2023-11-22 at 4 16 43 PM

Contributor guide

No contributing guide indexed for this repository

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

Open the filling layouts vignette and inspect the “In theory” section, especially the blue containers shown in the issue screenshot. Add a brief prompt explaining that readers can hover over the containers to reveal their tooltips, then confirm the guidance is visible and clear in the rendered article.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.