docs: General Improvements #789
Merged
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
Signed-off-by: Mary Jinglewski <maryjinglewski@honeycomb.io>
|
I've updated the template to add commas and break it up into separate values, and regenerated. |
TylerHelmuth
approved these changes
Jul 11, 2023
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.
Which problem is this PR solving?
This PR includes some improvements for generated documentation for Honeycomb docs site to match style guide standards. For example, "etc." is an abbreviation of a Latin expression - and the Honeycomb docs use American English only - but at the very least should have a period included when used.
This PR should also include a comma between generated options, but I will need @kentquirk's help with wrangling that.
For example, the options for https://docs.honeycomb.io/manage-data-volume/refinery/configuration/#type should have commas between them to improve clarity.
Short description of the changes