gbdev / gbdev/pandocs

Formalize figures requirements and guidelines

Open
#277 0 comments 0 reactions 0 assignees View on GitHub
meta
Dominant language
Markdown
Stars
783
Forks
134
Avg merge
6h 54m
Merged PRs (30d)
3

Description

We have been trying to transition from JPG and PNGs to SVG and generally scalable image formats.

I'd like to formalize this, so we can have clear requirements on the image formats and guidelines on colors/plots scales and image sizes, both for new additions and conversion of existing figures.

Contributor guide

Open the contributing guide

Research direction

No files or tests are named. Start by reviewing the existing JPG and PNG figures and the surrounding documentation, then define requirements for scalable formats, colors, plot scales, and image sizes covering both new figures and conversions. Done means the requirements and guidelines are documented clearly enough to apply consistently.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.