clearer headings in readme #88
Closed
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
Due to github's styling of markdown headings & `strong`, the readme is a little unclear as to which parts are methods of `store`, and which are top level API methods. I've added a `hr` and changed the `strong`s to `h6`s (which is arguably more semantically accurate) to try to improve the ease of scanning the docs. There were also some mistakes (I think) in the heading hierarchy, so I have promoted headings one or two levels
|
Hi @wheresrhys - I agree with your changes here, but unfortunately the "Usage" section of the README is actually generated by documentation.js, so it can't be modified directly. |
|
Ah ok. I'll raise it over there. Another day, another yak to shave. Now, where did I put that extra large razor? |
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.
Due to github's styling of markdown headings &
strong, the readme is a little unclear as to which parts are methods ofstore, and which are top level API methods. I've added ahrand changed thestrongs to headings (which is arguably more semantically accurate) to try to improve the ease of scanning the docs.There were also some mistakes (I think) in the heading hierarchy, so I have promoted some headings one or two levels