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

Adds Table of Contents to README #4357

Merged
merged 2 commits into from
Nov 16, 2017

Conversation

montymxb
Copy link
Contributor

@montymxb montymxb commented Nov 16, 2017

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.

@flovilmart
Copy link
Contributor

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
Copy link

codecov bot commented Nov 16, 2017

Codecov Report

Merging #4357 into master will decrease coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            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
Impacted Files Coverage Δ
src/RestWrite.js 93.32% <0%> (-0.19%) ⬇️
...dapters/Storage/Postgres/PostgresStorageAdapter.js 96.84% <0%> (-0.11%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update aa1e97f...2f43e1a. Read the comment docs.

@montymxb
Copy link
Contributor Author

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
Copy link
Contributor

Perfecft!

@flovilmart flovilmart merged commit e1d04cd into parse-community:master Nov 16, 2017
@montymxb montymxb deleted the readme-table-of-contents branch November 17, 2017 06:05
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants