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

Added a basic contents table links #235

Merged
merged 2 commits into from Jul 16, 2018

Conversation

davidyell
Copy link
Member

The readme is kinda big, so this pull request aims to mitigate that by adding a contents 'table' of links, to get to specific parts quicker.

@dereuromark
Copy link
Member

👎
I actually just proposed a few days ago to keep readme lean and move the docs mainly to a subdir /docs as recommended in general.
Then this becomes not necessary anymore, or could be part of the /docs README one.

@davidyell
Copy link
Member Author

I don't see why we can't merge this then in the meantime. As when the pull request for the next update comes through, we can overwrite this change.

@codecov
Copy link

codecov bot commented Jul 16, 2018

Codecov Report

Merging #235 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #235   +/-   ##
=========================================
  Coverage     96.46%   96.46%           
  Complexity      153      153           
=========================================
  Files            12       12           
  Lines           368      368           
=========================================
  Hits            355      355           
  Misses           13       13

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 5a017e3...4d0a964. Read the comment docs.

@dereuromark
Copy link
Member

dereuromark commented Jul 16, 2018

Why not moving it already now?
Adding this just invites the readme to get further exploded by too much content.

@davidyell
Copy link
Member Author

Sure, go for it 👍

@dereuromark
Copy link
Member

Do you want to move them to /docs/README.md ?
Keeping only the outline and basics in the readme then?

@davidyell
Copy link
Member Author

I don't see any value in such a small change. If we are going to use a /docs folder, there should be documentation for each logical section of the plugin, with links in the main repo readme.

@ADmad ADmad merged commit 7c14e0c into FriendsOfCake:master Jul 16, 2018
@davidyell davidyell deleted the readme-index branch July 16, 2018 13: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.

None yet

3 participants