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

Link Javadoc from README (prominently) #145

Closed
nkuehn opened this issue Oct 11, 2017 · 4 comments
Closed

Link Javadoc from README (prominently) #145

nkuehn opened this issue Oct 11, 2017 · 4 comments

Comments

@nkuehn
Copy link

nkuehn commented Oct 11, 2017

Description

To make it easier to start with, prominently link to the JavaDoc from the README.md

e.g. like done in the JVM SDK https://github.com/commercetools/commercetools-jvm-sdk

Context

We learnt this "the hard way" in the JVM SDK - if you don't put a very prominent link nobody reads al the hard work you have put in the JavaDocs. Had to send out the link separately to everybody.

@heshamMassoud
Copy link
Contributor

heshamMassoud commented Oct 12, 2017

@nkuehn it's there actually: https://github.com/commercetools/commercetools-sync-java#commercetools-sync
The last point in the TOC.. Maybe it's not very prominent/visible enough?

@nkuehn
Copy link
Author

nkuehn commented Oct 12, 2017

Probably not prominent enough - at least I oversaw it.
Same learning with the JVM SDK, seems like you have to really put a big button on the top of it to move users into the JavaDoc instead of reading the README which is focused on developers of the library.

@heshamMassoud heshamMassoud added this to the 1.0.0-M2 milestone Oct 12, 2017
@heshamMassoud
Copy link
Contributor

heshamMassoud commented Oct 12, 2017

@nkuehn https://github.com/commercetools/commercetools-sync-java#commercetools-sync It's now added as a badge in the README :)

instead of reading the README which is focused on developers of the library.

The dev contributing stuff are moved away now from the README. They are now in the CONTRIBUTING. So that the README is only focused on the users of the lib rather than its devs.

@heshamMassoud
Copy link
Contributor

Closing this issue now since it should be addressed by 5d72274.

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

No branches or pull requests

2 participants