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

Use "labels in quotes" for menu items, buttons and tabs, not preformatted text #130

Open
bencomp opened this issue Oct 18, 2022 · 1 comment
Labels
good first issue Good issue for first-time contributors help wanted Looking for Contributors

Comments

@bencomp
Copy link
Contributor

bencomp commented Oct 18, 2022

This is a chore, but I think an important one. The lesson style guide explains how to mark up various types of things we talk about.

One issue I see is that menu items, buttons and tabs (and other UI elements) are referred to by putting their labels in backticks. Backticks are for spans of code.

Menu items should be in double quotes (or "smart quotes" even), and I think the same should go for buttons and tabs. This helps distinguish menu items from text that needs to be typed, or that is literal text from the dataset.
Menu items and submenu items should be separated by a single > too.

@bencomp bencomp added help wanted Looking for Contributors good first issue Good issue for first-time contributors labels Oct 18, 2022
@bencomp
Copy link
Contributor Author

bencomp commented Oct 18, 2022

I just opened carpentries/lesson-example#379 for clarity on referring to buttons and tabs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good issue for first-time contributors help wanted Looking for Contributors
Projects
None yet
Development

No branches or pull requests

1 participant