search

github / docs

The open-source repo for docs.github.com
https://docs.github.com
Creative Commons Attribution 4.0 International
16.39k stars 59.95k forks source link

Inconsistent bullet list style #35344

Open akordowski opened 3 days ago

akordowski commented 3 days ago

Code of Conduct

What article on docs.github.com is affected?

Multiple articles

What part(s) of the article would you like to see updated?

I noticed that some lists have inconsistent style, even in the same article. One list uses the **Keyword**: Text format, other the **Keyword**—Text.

See here:

There are other few occurrences of the **Keyword**—Text style in other articles as well.

As the lists rather using the **Keyword**: Text style this should be unified.

Additional information

I could provide a PR for this issue.

nguyenalex836 commented 2 days ago

@akordowski Thank you for catching this inconsistency! I believe we would want to unify our docs to use the **Keyword**: Text style given it is more prominent, but I will put this up for review to get a second opinion from the team 💛

subatoi commented 2 days ago

Thank you @akordowski! I agree with @nguyenalex836 so I will let him open it to you to contribute accordingly.

nguyenalex836 commented 2 days ago

Thank you @subatoi! ✨

Looking forward to your PRs @akordowski 💛 Thank you again for your enthusiastic willingness to continually improve our docs!

akordowski commented 2 days ago

@nguyenalex836 It's my pleasure! 😊 Let my know when you got feedback from the team.

nguyenalex836 commented 2 days ago

@akordowski Oh, @subatoi's comment above was actually the feedback we were looking for! 💛

We should go ahead and unify our docs to use the **Keyword**: Text style - feel free to open PRs for this whenever you have time ✨