Table of Contents. Readme readability. #606
Closed
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.
Hi,
While adding
Pretty Print
description to the documentation (which is still in progress, I will submit PR later), I've realized it's a bit difficult to navigate through the whole readme/documentation page.So I added a table of contents. Please check and say what do you think?
Also played around with headers levels (h3 became h4, h4 became h6) to try increase readability for parameters enumerations (for example IgnoreObsoleteProperties, MapType, SchemaFilter, UseFullTypeNamesInSchemaIds etc).
Of course I can revert headers if you don't like how it looks now and leave only table of contents.
P.S. Commits can be squashed if needed.
Regards