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

Change scaladoc link title to "API Documentation" #2004

Closed
arosien opened this issue Nov 1, 2017 · 6 comments
Closed

Change scaladoc link title to "API Documentation" #2004

arosien opened this issue Nov 1, 2017 · 6 comments

Comments

@arosien
Copy link

arosien commented Nov 1, 2017

https://typelevel.org/cats/ has a link to the scaladoc, but the link text "Documentation" is confusing. Most projects refer to the scaladoc as "API Documentation".

@jiminhsieh
Copy link
Contributor

@arosien Do you mean the "Documentation" link at the right side of GitHub linked to https://typelevel.org/cats/api/cats/index.html in header?

@arosien
Copy link
Author

arosien commented Dec 28, 2017

@jiminhsieh, yes, that link. My issue is that the page itself (https://typelevel.org/cats/) is the documentation, and that link is to the scaladoc / API documentation, so I want the link to be more precise.

@Obarros
Copy link
Contributor

Obarros commented Jun 9, 2018

@arosien , @jiminhsieh, @LukaJCB is this something that we want still?

According to my findings, we will need to do this on the sbt-microsite first in order to achieve it:

/~https://github.com/47deg/sbt-microsites/blob/c06973586873c4addab34d1af08f1eef95c3a6d8/src/main/scala/microsites/layouts/Layout.scala#L290

@LukaJCB
Copy link
Member

LukaJCB commented Jun 15, 2018

Yes, I think we should add an issue to microsites to figure out if we can add a feature for it :)

@Obarros
Copy link
Contributor

Obarros commented Jun 17, 2018

Great, I create the issue.

47degrees/sbt-microsites#267

I will be happy to create the PR there, let's see the feedback and update here later.

@Obarros
Copy link
Contributor

Obarros commented Jun 19, 2018

@LukaJCB, new version of the sbt-microsites plugin (0.7.20) with the PR merged released with the change we need to make this happen! 👍

I will create a PR to address it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants