chore(docs): cleanup wording and syntax #88
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
This makes sure that the heading levels are consistent with the heading levels expected by Antora, i.e. page needs to start at heading 1 in order to have the title set. Makes sure that code block titles are set at the right place. Rewords the examples, the trying out locally in particular and structures the examples in sections.
oscerd
approved these changes
Feb 11, 2020
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.
This makes sure that the heading levels are consistent with the heading
levels expected by Antora, i.e. page needs to start at heading 1 in
order to have the title set.
Makes sure that code block titles are set at the right place.
Rewords the examples, the trying out locally in particular and
structures the examples in sections.