docs: Add sections for Features, Getting Started, Guidance, and Resources in README#547
Open
VishalS-Microsoft wants to merge 1 commit intodevfrom
Open
docs: Add sections for Features, Getting Started, Guidance, and Resources in README#547VishalS-Microsoft wants to merge 1 commit intodevfrom
VishalS-Microsoft wants to merge 1 commit intodevfrom
Conversation
VishalS-Microsoft
requested review from
Avijit-Microsoft,
Prajwal-Microsoft,
Roopan-Microsoft,
Vinay-Microsoft,
aniaroramsft,
dgp10801,
nchandhi and
toherman-msft
as code owners
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
1 participant
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.
Purpose
This pull request updates the
README.mdto improve the organization and clarity of section headings. The changes standardize the heading levels and make section titles more consistent, which should make the documentation easier to navigate.Documentation improvements:
###) to level 2 (##) for better consistency and visibility, including renaming sections such as "How to customize" to "Guidance", "Additional resources" to "Resources", "Key features" to "Features", and "How to install or deploy" to "Getting Started". [1] [2] [3] [4]Does this introduce a breaking change?
Golden Path Validation
Deployment Validation
What to Check
Verify that the following are valid
Other Information