Lightning-AI / Lightning-AI/pytorch-lightning

Unreadable font color theme of YAML files

Open
#20,335 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Python
Stars
31.4k
Forks
3.8k
Avg merge
6d 7h
Merged PRs (30d)
6

Description

### 📚 Documentation

The color theme for YAML files in the documentation is unreadable (dark blue on black background) like [on this site](https://lightning.ai/docs/pytorch/stable/cli/lightning_cli_advanced.html). Here is an image:
![Screenshot from 2024-10-10 12-38-15](https://github.com/user-attachments/assets/527f53e4-09a2-4327-ad54-6aae660f0054)

cc @borda

Contributor guide

Open the contributing guide

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.

Research direction

Open the linked documentation page and inspect how the YAML code block theme is configured, then locate the documentation styling entry point controlling the dark-blue-on-black colors. Done means YAML examples on the page have readable contrast and the result can be verified on the affected documentation page.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
accessibility, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.