Cats: Change scaladoc link title to "API Documentation"

Created on 1 Nov 2017  路  6Comments  路  Source: typelevel/cats

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".

documentation low-hanging fruit

All 6 comments

@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?

@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.

@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

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

Great, I create the issue.

https://github.com/47deg/sbt-microsites/issues/267

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

@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!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

kailuowang picture kailuowang  路  3Comments

fosskers picture fosskers  路  3Comments

chuwy picture chuwy  路  4Comments

durban picture durban  路  4Comments

non picture non  路  3Comments