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

Create a boxes/formatting for Warnings, Notes #195

Open
chalmerlowe opened this issue Apr 23, 2023 · 3 comments
Open

Create a boxes/formatting for Warnings, Notes #195

chalmerlowe opened this issue Apr 23, 2023 · 3 comments

Comments

@chalmerlowe
Copy link
Owner

chalmerlowe commented Apr 23, 2023

There are several places where we have paragraphs labeled as NOTES and there is very little to denote that a blurb is a NOTE. One example can be found on git_cloning.md
Consider using some form of uniform formatting to highlight that a paragraph is a NOTE. Ideas might include:

  • a box around the text
  • a background color for the text (pale yellow?)
  • an icon

Also, there are several notes that might be better defined as WARNINGS. Using a similar design construct as for the notes above, create a format for WARNINGS.

  • consider a color like pale red
  • a warning icon
@Travis-Magaluk
Copy link

Happy to work on this. Before I get too far, what are your thoughts on this initial image of some sample text in colored boxes?
Screenshot 2023-05-06 at 2 51 21 PM

@chalmerlowe
Copy link
Owner Author

Thanks for creating a suggestion.
The terms NOTE and WARNING look good.
The NOTE icon is probably fine.
The WARNING icon should be something like a red and white icon.
I am more worried about the box and the color and least worried about any specific icon.
I tend to lean toward a more pastel pallet for colors.

I am in a rush, sorry I don't have examples off the top of my head for each of the items above. I will see what I can do to dig something up.

jdabassett added a commit to kpgomez/intro_to_sprinting that referenced this issue Feb 1, 2024
@jdabassett
Copy link

I hope that helps.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants