chore: update the readme for hidi examples and commands #2252
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
musale
requested review from
MaggieKimani1,
andrueastman,
baywet,
darrelmiller,
gavinbarron,
irvinesunday and
millicentachieng
as code owners
MaggieKimani1
approved these changes
Mar 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This pull request focuses on improving the documentation for the
Microsoft.OpenApi.Hiditool by formatting command examples and parameters using code blocks and inline code for better readability. The most important changes include the addition of bash code blocks for commands and the use of inline code for command options.Improvements to documentation readability:
src/Microsoft.OpenApi.Hidi/readme.md: Added bash code blocks for global and local installation commands to enhance readability.src/Microsoft.OpenApi.Hidi/readme.md: Formatted example commands using bash code blocks and added inline code for command options to improve clarity.