docs: audit and fix missing language tags in markdown code blocks#6790
Open
vanshika2720 wants to merge 2 commits into
Open
docs: audit and fix missing language tags in markdown code blocks#6790vanshika2720 wants to merge 2 commits into
vanshika2720 wants to merge 2 commits into
Conversation
Signed-off-by: Vanshika <pahalvanshikaa@gmail.com>
4bd7cf6 to
d68c835
Compare
Author
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
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.
What this PR does:
Audits all active (non-versioned) documentation markdown files under
docs/content/en/and adds the appropriate language syntax highlighting tags (bash,yaml,hcl,terraform,console,text) to all code blocks that previously used plain untagged backticks (```).Specifically, this PR fixes 28 code blocks across 9 active documentation files:
pipectlCLI examples)Why we need it:
Without specifying language tags, code blocks render as unstyled plain text on the generated documentation site. Adding appropriate syntax tags enhances readability, visually structures the commands, and provides a polished developer experience for users reading the documentation.
Does this PR introduce a user-facing change?: