Skip to content

Replace all Apple glyph names with their HTML code #20

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

Merged
merged 4 commits into from
Apr 3, 2021

Conversation

codedbypm
Copy link
Contributor

In this PR:

  • added a keyboard shortcut for fix-its hint
  • replace all Cmd/Alt/Ctrl/Shift/etc with apple glyphs ⌘ ⌥ ⌃ ⇧ etc..

@codedbypm
Copy link
Contributor Author

I haven't found a way to have glyphs shown between backticks so I decided to bold them all. Let me know what you all think.

@codedbypm codedbypm requested a review from jessesquires April 3, 2021 12:45
@jessesquires
Copy link
Member

jessesquires commented Apr 3, 2021

Thanks @codedbypm ! 🎉 💯 I think this looks great.

The only thing is that the section "Quick reference for Apple glyphs HTML codes" is very prominent, which feels a bit awkward.

What if we put that at the very bottom of the page, or in its own page?

EDIT: Oh actually, what about putting the HTML code cheat sheet in the contributing guide?
https://github.com/Xcode-Tips/xcode-tips.github.io/blob/main/.github/CONTRIBUTING.md

@codedbypm
Copy link
Contributor Author

codedbypm commented Apr 3, 2021

Thanks @codedbypm ! 🎉 💯 I think this looks great.

The only thing is that the section "Quick reference for Apple glyphs HTML codes" is very prominent, a feels a bit awkward.

What if we put that at the very bottom of the page, or in its own page?

EDIT: Oh actually, what about putting the HTML code cheat sheet in the contributing guide?
https://github.com/Xcode-Tips/xcode-tips.github.io/blob/main/.github/CONTRIBUTING.md

I share your same opinion about that reference.
My assumption is this: PRs containing the symbol names cmd or shift etc.. should not be accepted unless they use the glyphs. This is for the sake of having a consistent document.
If you share my same assumption, then we need the reference somewhere to ease the job to contributors.
I initially put it at the very top of the README.md but in a comment block, thus visible only if you edit the file :D
But let me know. I'm fine to put it at the bottom too or on another page. I don't have a big preference here.

EDIT: I like the idea of putting it in the CONTRIBUTING.md

@jessesquires
Copy link
Member

PRs containing the symbol names cmd or shift etc.. should not be accepted unless they use the glyphs. This is for the sake of having a consistent document.

totally agree!

I like the idea of putting it in the CONTRIBUTING.md

Let's go with this!

Let's also add a note to the steps: "Please use Apple Glyphs when mentioning keyboard shortcuts." 😊

@codedbypm
Copy link
Contributor Author

Please review

Copy link
Member

@jessesquires jessesquires left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @codedbypm ! 💯

@jessesquires jessesquires merged commit 9a106d0 into main Apr 3, 2021
@jessesquires jessesquires deleted the use-apple-glyphs branch April 3, 2021 19:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants