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.

Sign up for GitHub

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

Jump to bottom

Add link to scaladoc in README.md #2003

Closed
arosien opened this issue Nov 1, 2017 · 0 comments · Fixed by #2048
Closed

Add link to scaladoc in README.md #2003

arosien opened this issue Nov 1, 2017 · 0 comments · Fixed by #2048
Labels
documentation low-hanging fruit

Comments

@arosien
Copy link

arosien commented Nov 1, 2017 •
edited
Loading

The only way to discover the cats scaladoc is to go to https://typelevel.org/cats/ and click "Documentation"; the link is not available from the README.md on the GitHub project page.

The link could be at the bottom of the "Overview" section or in the "Getting Started" section.

The link title should also be "API Documentation" vs. "Documentation". Other projects use this terminology for scaladoc link titles.

I also recommend linking directly to https://typelevel.org/cats/api/cats/index.html to avoid sending people to the root package doc, which is confusing. (everyone then just clicks the cats package link anyway)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation low-hanging fruit
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add direct link to the scaladoc in README.md
2 participants
@arosien @LukaJCB