Qiskit / documentation

The documentation content home for https://docs.quantum.ibm.com.
https://docs.quantum.ibm.com
Apache License 2.0
39 stars 81 forks source link

The table with error codes does not break lines correctly and forces horizontal scrolling #2371

Open 1ucian0 opened 5 hours ago

1ucian0 commented 5 hours ago

URL to the relevant documentation

https://docs.quantum.ibm.com/errors

Please describe the UI problem.

https://github.com/user-attachments/assets/c554788c-a47e-430c-af31-5bc6fa86be51

Reading the error code table is hard. It seems like break lines where it should not.

Eric-Arellano commented 5 hours ago

It seems like break lines where it should not.

Do you mean there should be newlines inside individual table cells and there are not?

--

One challenge with this page is we cap the max-width of the main content to 800px. That is due to accessibility recommendations that you do not want your text-heavy site to be too wide because it makes reading harder. I believe the 800px comes from Carbon. However, I'll ask the designers if we could revisit that max to be something more useful like 900px or 1000px.

1ucian0 commented 4 hours ago

Lol... my usually-broken English found a new record.

I mean that table should fit in the column to avoid the horizontal screening and, if the line is too long, it should break accordingly.