Changes for the headline structure of the readme #46
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
The readme had an incoherent headline structure which made the comprehension a bit difficult. It was cumbersome to distinguish between the `vagrant` part and the `docker` part due to the fact the `vagrant` was an `h1` while `docker` was an `h2`. and right before the docker part there were the `configuration` and `usage` parts which were also an `h1` making the impression that all steps might be necessary even though you just want to use the `docker` part. instead they are two complete different processes. therefor i would suggest make the vagrant and docker headlines each a `h2` so the only `h1` in the document is the `visual regression testing made easy`. and all the sub headlines of `vagrant` and `docker` a `h3`. that would be a quick and easy fix to make the readme a bit easier to comprehend.
rpkoller
changed the title
|
Thanks a lot for your contribution @rpkoller |
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.
The readme had an incoherent headline structure which made the comprehension a bit difficult. It was cumbersome to distinguish between the
vagrantpart and thedockerpart due to the fact thevagrantwas anh1whiledockerwas anh2. right before the docker part there were theconfigurationandusageparts which were also anh1making the impression that all steps might be necessary even though you just want to use thedockerpart. instead they are two complete different processes.therefor i would suggest make the vagrant and docker headlines each a
h2so the onlyh1in the document is thevisual regression testing made easy. also making all the sub headlines ofvagrantanddockerah3. that would be a quick and easy fix to make the readme a bit easier to comprehend.