feat: introduce a style guide #2996
Conversation
✅ Deploy Preview for gis-utah-gov ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| <h3>Capitalization</h3> | ||
| <p>The following terms are always capitalized:</p> | ||
| <BulletedList> | ||
| <li>State (when referring to the political entity)</li> |
There was a problem hiding this comment.
Stephanie pointed out that this bit about capitalizing state conflicts with DGO's style guide. Apparently they like 'state of Utah' better than State of Utah, so we can remove this bit about capitalizing state.
| </BulletedList> | ||
| <h3>Numbers and units</h3> | ||
| <BulletedList> | ||
| <li>Spell out numbers one through ten. For larger numbers, use numerals.</li> |
There was a problem hiding this comment.
| <li>Spell out numbers one through ten. For larger numbers, use numerals.</li> | |
| <li>Spell out numbers one through ten. For larger numbers, use numerals.</li> |
Change to: "Unless a number begins a sentence, use numerals as opposed to spelling the word out", per Stephanie's recommendation.
|
@steveoh I've added in a few notes from Stephanie for the style guide, otherwise I think we're good to go! The only thing I might consider changing, aesthetics wise, is indenting some of the sub-bullet points further in (like the ones that are an example of a previously stated point). I think that would make them look more like a sub-point, and not just that the bullets got a little funky. I like the separation with the colors, I think it looks great overall. |
| </li> | ||
| <li>ArcGIS Pro</li> | ||
| <li>QGIS</li> | ||
| <li>Lidar (capitalize the L only, rather than LIDAR or LiDAR)</li> |
There was a problem hiding this comment.
| <li>Lidar (capitalize the L only, rather than LIDAR or LiDAR)</li> | |
| <li>lidar (rather than LIDAR or LiDAR). It should be lower case 'lidar' all of the time, with the exception of when it is at the beginning of a sentence, used in a title, or when the writer feels like emphasizing the word.</li> |
This is info that @rkelson sent me. I'm just trying to get it into the doc.
There was a problem hiding this comment.
Thanks Scott. When we rebuilt the website, Rick chose Lidar for all the uses as shown everywhere in the website. As long as we keep things consistent, what the value is is not important.
There was a problem hiding this comment.
I totally agree. I don't care which of the variations we go with as long as a decision is made. The fact that this PR has sat for months without being merged seems to indicate that there is still work to be done.
There was a problem hiding this comment.
It's my interpretation that most of the work was done in the google doc so I hope we don't spend too many more cycles on it. I think @leault and @chriswnek will help get it across the finish line.
here we go!