firecracker-microvm/firecracker-containerd

docs: some images less accessible for dark GitHub themes

Open

#603 opened on Apr 8, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (242 forks)auto 404
documentationexp/beginnergood first issue

Repository metrics

Stars
 (2,876 stars)
PR merge metrics
 (PR metrics pending)

Description

if using one of the GitHub dark themes, it is near impossible to view documentation images such as

https://github.com/firecracker-microvm/firecracker-containerd/blob/main/docs/img/design-overview.png

and

https://github.com/firecracker-microvm/firecracker-containerd/blob/main/docs/img/design-sequence-diagram.png

due to their usage of black text and transparent background.

It would be nice if we could convert these images to have a white/higher contrast background so they can be viewed using any GitHub theme.

Contributor guide

Research direction
Create updated versions of the images with a white or high contrast background, ensuring text is readable on both light and dark themes. Commit the new images and update any references if needed.
Tech stack
go
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Gitimage editing tool
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90