Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Table of Contents. Readme readability. #606

Conversation

gordey4doronin
Copy link
Contributor

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

@gordey4doronin
Copy link
Contributor Author

@domaindrivendev Could you please check how readme looks in this PR?
If you like it - I will do a rebase and resolve a conflict.

I also noticed you just released the new version (I got an email notification on some closed PRs);
Unfortunately I totally forgot about Pretty Print documentation description. I will add it soon.

@gordey4doronin
Copy link
Contributor Author

Rebased f280ebb

@domaindrivendev
Copy link
Owner

Closing as there's a broader initiative around docs gaining traction with the help of @lockewritesdocs and @heldersepu. See #1053 (comment)

@gordey4doronin gordey4doronin deleted the feature/table-of-contents branch June 5, 2017 04:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants