llvm / llvm/llvm-project

[clang-doc] Pages with long lines of text cause long horizontal scroll issues

Open
#173,424 0 comments 0 reactions 0 assignees View on GitHub
clang-doc
Dominant language
LLVM
Stars
40.5k
Forks
18.7k
PR merge metrics
PR metrics pending

Description

https://github.com/user-attachments/assets/d87d5fce-49c6-43a6-8976-d091cc02ff7e

Attached is an example of the horizontal scroll issue.

This might be caused by the fact that names use `

` tags, so there is no wrapping since all text is rendered as-is. We should wrap long names so that there is no scrolling past the view port.

Contributor guide

Open the contributing guide

Research direction

Start with clang-doc's generated HTML output and inspect the

 rendering described in the report. Reproduce the attached long-name case in a narrow viewport, then verify that long names wrap without horizontal scrolling.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.