Lightning-AI / Lightning-AI/pytorch-lightning
Docs style renders unreadable yaml code snippets
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 31.4k
- Forks
- 3.8k
- Avg merge
- 6d 7h
- Merged PRs (30d)
- 6
Description
### 📚 Documentation
When a code snippet is yaml, the keys are rendered in a dark blue with a black background, making it ugly and difficult to read. See for example [what-is-a-yaml-config-file](https://lightning.ai/docs/pytorch/stable/cli/lightning_cli_faq.html#what-is-a-yaml-config-file).
cc @borda
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked rendered page at the what-is-a-yaml-config-file anchor and inspect the documentation styling or configuration responsible for YAML code blocks. Confirm the dark-blue-on-black rendering and update the relevant presentation so YAML keys are readable; done when the example displays with clear contrast.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100