Adds Table of Contents to README #4357
Merged
Conversation
This file contains hidden or 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
| Can we remove the line break here (https://github.com/parse-community/parse-server/pull/4357/files#diff-04c6e90faac2675aa89e2176d2eec7d8R8) so all shields are on 1 line :) |
Codecov Report
@@ Coverage Diff @@ ## master #4357 +/- ## ========================================== - Coverage 92.67% 92.64% -0.03% ========================================== Files 119 119 Lines 8435 8435 ========================================== - Hits 7817 7815 -2 - Misses 618 620 +2
Continue to review full report at Codecov.
|
| Went ahead and moved greenkeeper up there as well so it's not on it's own. Let me know if that's fine. |
flovilmart approved these changes Nov 16, 2017
| Perfecft! |
UnderratedDev pushed a commit to UnderratedDev/parse-server that referenced this pull request Mar 21, 2020
* adds table of contents * remove empty line, moved greenkeeper up with other statuses
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
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.
There's a lot in the README and there's no navigation currently. This adds a table of contents to allow new users to quickly understand what's listed where and jump to relevant sections.
While I was doing this I noticed a few things in the structure of the README that were a bit odd. I've put together this table of contents in a way that I think best represents the logical layout of the README. I would like to hear some opinions on it though, see if we should perhaps consider shifting sections around.