chalmerlowe / intro_to_sprinting

A gentle introduction to contributing to open source projects / open source sprints
Other
107 stars 115 forks source link

Create a boxes/formatting for Warnings, Notes #195

Open chalmerlowe opened 1 year ago

chalmerlowe commented 1 year ago

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:

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.

Travis-Magaluk commented 1 year ago

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 commented 1 year ago

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 commented 8 months ago

I hope that helps.