HDS Content - Adding Writing Guidelines and Writing Style #2576
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Image added to the Date/Time docs
majedelass
changed the title
…specific to that. Added illustrations and content images
dchyun
reviewed
Nov 25, 2024
LilithJames-HDS
requested changes
Nov 25, 2024
Co-authored-by: LilithJames-HDS <[email protected]>
LilithJames-HDS
approved these changes
Nov 25, 2024
shleewhite
reviewed
Nov 25, 2024
shleewhite
reviewed
Nov 25, 2024
majedelass
changed the title
majedelass
changed the title
LilithJames-HDS
requested changes
Nov 25, 2024
shleewhite
reviewed
Nov 25, 2024
heatherlarsen
requested changes
Nov 26, 2024
jorytindall
reviewed
Nov 26, 2024
majedelass
changed the title
majedelass
requested review from
heatherlarsen,
LilithJames-HDS,
jorytindall and
shleewhite
heatherlarsen
approved these changes
Nov 26, 2024
|
|
||
| !!! | ||
|
|
||
| ## Punctuation | ||
|
|
||
| ### Serial/Oxford comma | ||
|
|
||
| Use the serial (“Oxford”) comma in lists. | ||
| Use the [serial (“Oxford”)](https://www.grammarly.com/blog/punctuation-capitalization/what-is-the-oxford-comma/) comma in lists. |
There was a problem hiding this comment.
Suggested change
| Use the [serial (“Oxford”)](https://www.grammarly.com/blog/punctuation-capitalization/what-is-the-oxford-comma/) comma in lists. | |
| Use the [serial (“Oxford”) comma](https://www.grammarly.com/blog/punctuation-capitalization/what-is-the-oxford-comma/) in lists. |
| @@ -277,13 +282,15 @@ We are excited to announce Vault 1.3! | |||
|
|
|||
| ### Percentages | |||
|
|
|||
| Use the % symbol instead of spelling out "percent." Correct: 50% | |||
| Use the % symbol instead of spelling out "percent"; e.g. , `50%`. | |||
There was a problem hiding this comment.
Suggested change
| Use the % symbol instead of spelling out "percent"; e.g. , `50%`. | |
| Use the % symbol instead of spelling "percent," e.g., `50%`. |
|
|
||
| - Terraform Registry | ||
| - Terraform Stacks | ||
| - Raft algorithm |
There was a problem hiding this comment.
Shouldn't this be:
Suggested change
| - Raft algorithm | |
| - Raft Algorithm |
|
|
||
| Use an en dash (–) to indicate a range or span of numbers. | ||
|
|
||
|  |
There was a problem hiding this comment.
There should not be regular spaces before and after the en dash
Suggested change
|  | |
|  |
There was a problem hiding this comment.
Since its just normal text, you can just have the alt text be what it says.
Suggested change
|  | |
|  |
jorytindall
approved these changes
Nov 26, 2024
shleewhite
reviewed
Nov 27, 2024
| These formatting options are available in the [Time](#) component. Choose the format most appropriate for your user needs. | ||
|
|
||
| - **Relative date**: Displays time in relative terms, e.g., "3 hours ago" or "in 2 days". This format is recommended for recent events, particularly within the past or upcoming week, as it simplifies recognition of time-sensitive actions. | ||
| - **Friendly date**: Provides a user-friendly date and time, e.g., "Sep 5, 2018, 3:30 PM EST". Ideal for displaying the date and time to who, or what, set it. Limit time format to the minute. |
There was a problem hiding this comment.
Suggestion: it may just be me, but I am not really sure what "Ideal for displaying the date and time to who, or what, set it" means. what does it mean to display a time to what set it?
There was a problem hiding this comment.
I agree that it's confusing.
|
|
||
|  | ||
|
|
||
|  |
There was a problem hiding this comment.
Suggested change
|  | |
|  |
|
|
||
| Use an en dash (–) to indicate a range or span of numbers. | ||
|
|
||
|  |
There was a problem hiding this comment.
Since its just normal text, you can just have the alt text be what it says.
Suggested change
|  | |
|  |
|
|
||
| Use the % symbol instead of spelling out "percent"; e.g. , `50%`. | ||
|
|
||
|  |
There was a problem hiding this comment.
Suggested change
|  | |
|  |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📌 Summary
If merged, this PR will apply content to the content section for both the "Voice and Tone" and "Writing for UI Copy" docs.
🔗 External links
Jira ticket: HDS-4183
Jira ticket: HDS-4184
👀 Component checklist
💬 Please consider using conventional comments when reviewing this PR.