docs: improve docs by using code-styled markdown #253
Merged
Conversation
This file contains hidden or 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
stirby
approved these changes
Jul 2, 2024
Contributor
stirby
left a comment
stirby
left a comment
There was a problem hiding this comment.
Great improvements to consistency and maturity. Nice addition.
mtojek
approved these changes
Jul 3, 2024
Member
mtojek
left a comment
mtojek
left a comment
There was a problem hiding this comment.
As CI is happy, I'm happy too 👍
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
Makes use of backticks to format resources and data sources names in docs.
Also resolves a mix use of backticked and quoted strings.
The format I tried to follow is:
namesand their properties'namesre formated as code-blocks. e.g.,coder_agent,startup_scriptetc."values"of any property are formatted as quoted code blocks. e.g., forsharethe values are"owner","authenticated"and"public".trueandfalseare formated as code-blocks.Also fixes #203
Contributes to #217
Tip
Docs previews generated at https://registry.terraform.io/tools/doc-preview