Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Improve figure readability in dark mode

Open
  • Is something wrong?
#63 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
r
Domain
documentation

Research direction

Start with vignettes/diagram-helpers.Rinc, which explicitly draws pale node fills and white label backgrounds causing the black patches. For vignette plots, locate the chunks rendering check_partner_dependence() and check_residuals() and test the given fig.class = "", dev.args = list(bg = "white") option to disable pkgdown inversion. Note the open design question on whether residual-check plots keep dark-mode adaptation — confirm the choice with maintainers, then rebuild the pkgdown site and inspect README plus APIM/DIM/DSM vignettes in both themes.

Written by the indexing model from the issue text.

Description

documentation priority: low question

The website currently handles figures differently in dark mode:

  • The README’s check_partner_dependence() plot keeps its original colours and white background.
  • The vignette plots are automatically colour-inverted by pkgdown.
  • Model diagrams have transparent canvases, but their pale node fills and white label backgrounds turn black, creating patches against the dark grey page.

Examples: README and APIM vignette.

Diagnostic plots: which appearance works best?

One proposal is to keep check_partner_dependence() plots in their original colours on white backgrounds throughout the documentation. This may make small labels and reference lines easier to read and would match the README.

However, dark plots blend into the page and avoid a large bright area.

For residual-check plots (check_dyad_residuals()), should we retain dark-mode adaptation or also use the original colours on white? Should both diagnostic functions follow the same approach?

Opinions are welcome, particularly about label readability, reference-line visibility, and viewing comfort. Compare examples in both themes before deciding.

Model diagrams

Keep diagrams readable in both themes, with node interiors and label backgrounds blending into the page instead of becoming black patches.

The shared diagram helper explicitly draws pale node fills and white label backgrounds. Some label backgrounds hide arrows behind the text, so simply making every fill transparent could reduce readability.

Implementation notes

For vignette plots that should remain white, these chunk options disable pkgdown’s automatic inversion and override the transparent background:

fig.class = "", dev.args = list(bg = "white")

Diagram changes belong in vignettes/diagram-helpers.Rinc. Preserve the existing layout, labels, and meaning of colours.

Tasks
  • Agree on the appearance of partner-dependence and residual-check plots.
  • Apply the chosen treatment consistently wherever those plots appear in the documentation.
  • Remove unwanted black fills from model diagrams while keeping labels clear of arrows.
  • Inspect affected figures in light and dark mode, including the README, APIM/DIM/DSM vignettes, and relevant function-reference pages.
  • Check that standalone vignettes remain readable.
Dominant language
R
Stars
1
Forks
2
Avg merge
19h 46m
Merged PRs (30d)
40

Getting set up

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.

More from Pascal-Kueng/dyadMLM

All issues in Pascal-Kueng/dyadMLM

Similar issues

More R issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.