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

Inconsistent bullet list style #35344

Closed
1 task done
akordowski opened this issue Nov 19, 2024 · 5 comments · Fixed by #35359
Closed
1 task done

Inconsistent bullet list style #35344

akordowski opened this issue Nov 19, 2024 · 5 comments · Fixed by #35359
Labels
content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review

Comments

@akordowski
Copy link
Contributor

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.

@akordowski akordowski added the content This issue or pull request belongs to the Docs Content team label Nov 19, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 19, 2024
@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Nov 19, 2024
@nguyenalex836
Copy link
Contributor

@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
Copy link
Contributor

subatoi commented Nov 19, 2024

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

@nguyenalex836
Copy link
Contributor

Thank you @subatoi! ✨

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

@akordowski
Copy link
Contributor Author

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

@nguyenalex836
Copy link
Contributor

nguyenalex836 commented Nov 19, 2024

@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 ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants