django / django/djangoproject.com

Low contrast boxes on new documentation webpages

Open
#198 8 comments 0 reactions 0 assignees Claimed by @xi View on GitHub
accepted docs medium priority needs design work styles
Dominant language
Python
Stars
2k
Forks
1.1k
Avg merge
3d 10h
Merged PRs (30d)
33

Description

FWIW, on my screen and seen with my eyes, the boxes on the new documentation pages have a background colour almost as bright as the main background. This way, the contrast is reduced compared to the old pages, making quick skimming more difficult.

For instance, look at the code snippets on https://docs.djangoproject.com/en/1.7/intro/overview/ and the adminition boxes on https://docs.djangoproject.com/en/1.7/intro/install/

Contributor guide

No contributing guide indexed for this repository

Research direction

Compare the code snippets on the overview page and the admonition boxes on the install page linked in the issue, then inspect the documentation site's styling entry points. Done means those boxes are visibly distinct from the main background and easier to skim, with contrast improved over the reported appearance.

Written by the indexing model from the issue text.

Assessment

Domain
accessibility, design, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.