Lightning-AI / Lightning-AI/pytorch-lightning

The color scheme of yaml code in the document makes it difficult to read

Open
#19,599 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

📚 Documentation
截屏2024-03-08 18 09 26

The black background and the dark blue text makes the code really difficult to read.

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

Start by locating the documentation page or rendering configuration responsible for the YAML code shown in the attached screenshot. The work is done when the YAML text has sufficient contrast against its background and the documentation rendering remains readable.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.