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

Do not use emojis instead of words #1301

Closed
dbuenzli opened this issue Feb 3, 2025 · 1 comment · Fixed by #1308
Closed

Do not use emojis instead of words #1301

dbuenzli opened this issue Feb 3, 2025 · 1 comment · Fixed by #1308
Labels
Milestone

Comments

@dbuenzli
Copy link
Contributor

dbuenzli commented Feb 3, 2025

I just tested the beta because of an annoying preamble bug I had in 2.4. It's fixed :–)

But I just saw that in the breadcrumbs, the emoji 🏠 is used to denote top or index. These bring the following two problems:

  1. Using emojis instead of words is bad for accessibility.
  2. From a styling perspective, adding emojis or icons is best done through CSS like @yawaramin did in https://github.com/ocaml/odoc/pull/1089/files, this allows to have icons that are consistent with the style (e.g. that house emoji with odig's default stylesheet really screams on the page and needlessly attracts the eye).
@dbuenzli dbuenzli added the output label Feb 3, 2025
@panglesd
Copy link
Collaborator

panglesd commented Feb 4, 2025

Yes, that is true. I would slightly be in favor of letting the driver choose a name (and make it "Index" in odoc_driver).

@jonludlam jonludlam added this to the 3.0 milestone Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants