Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Docs font and color suggestions #1131

Closed
Tracked by #479
levbishop opened this issue Apr 4, 2024 · 2 comments
Closed
Tracked by #479

API Docs font and color suggestions #1131

levbishop opened this issue Apr 4, 2024 · 2 comments
Assignees
Labels
design 🎨 user feedback 📥 General user feedback for design research purposes

Comments

@levbishop
Copy link
Member

Feedback

For example https://docs.quantum.ibm.com/api/qiskit/qiskit.primitives.StatevectorSampler
image

Problems making this hard to read:

  1. So much white space, such tiny text
  2. Serif font
  3. Low contrast darkish gray on slightly less darkish gray (especially for comments)
  4. proportional font for code(!)

Compare to eg tensorflow (which isn't anything special just the first thing came to mind)
image

  1. Less white space, larger text
  2. Sans serif
  3. High contrast. Comments are magenta on light gray
  4. Monospace code

Other comments

No response

@levbishop levbishop added content 📄 user feedback 📥 General user feedback for design research purposes labels Apr 4, 2024
@Eric-Arellano Eric-Arellano changed the title API Docs are pretty illegible API Docs are illegible due to font not loading Apr 4, 2024
@Eric-Arellano
Copy link
Collaborator

The font is not loading correctly for you, which is something we've been trying to figure because it only sometimes happens. For example, I cannot reproduce. Although some of the suggestions apply regardless of the font - like coloring code comments.

I'll message you for help with debugging the font not loading.

@Eric-Arellano Eric-Arellano changed the title API Docs are illegible due to font not loading API Docs font and color suggestions Apr 4, 2024
@Eric-Arellano Eric-Arellano moved this to In Progress in Docs Planning Aug 7, 2024
@Eric-Arellano
Copy link
Collaborator

Thanks for the comments, @levbishop! We've rolled out a few improvements since your issue:

  1. the font loading bug is fixed
  2. font-size increased from 12px to 14px
  3. comments have more contrast than before

Your feedback was really helpful!

Screenshot 2024-08-08 at 10 43 42 AM

@github-project-automation github-project-automation bot moved this from In Progress to Done in Docs Planning Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design 🎨 user feedback 📥 General user feedback for design research purposes
Projects
Archived in project
Development

No branches or pull requests

7 participants