[docs]: Diagrams are hard to read in dark mode
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 71
- Forks
- 91
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 22
Description
Version
Documentation website
Describe the bug
When reading the documentation page in dark mode, the diagrams are hard to read
-
-
https://github.com/pulp/pulp_deb/blob/main/docs/user/guides/sync.md
-
https://github.com/pulp/pulp_deb/blob/main/docs/user/guides/sync.svg
To Reproduce
Open the docs web site:
Look at the diagram in light and dark mode
Expected behavior
The diagram images have gray arrows that can be distinguished in either white or black background.
Additional context
Setting the black arrows to a ticker line and 50% gray might solve this issue.
This issue affects many diagrams, so I suggest that the diagram patch is applied to all diagrams.
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.
Research direction
Start with docs/user/guides/sync.svg and its reference in docs/user/guides/sync.md, then compare the diagram on the documentation site in light and dark mode. Identify the other diagrams affected by the same styling and update them consistently. Done means the arrows are distinguishable against both backgrounds across the documentation site.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100