auth0 / java-jwt

Java implementation of JSON Web Token (JWT)
MIT License
5.84k stars 921 forks source link

Javadoc contains dead links to readme #675

Closed Farbfetzen closed 9 months ago

Farbfetzen commented 10 months ago

Checklist

Description

The documentation in the code contains some dead links to the readme. For example see https://github.com/auth0/java-jwt/blob/master/lib/src/main/java/com/auth0/jwt/algorithms/Algorithm.java#L187. There is no section "hmac-key-length-and-security" in the current readme.

Reproduction

Click on the link in the javadoc of com.auth0.jwt.algorithms.Algorithm#HMAC512(java.lang.String).

Additional context

No response

java-jwt version

4.4.0

Java version

any

jimmyjames commented 9 months ago

Thanks @Farbfetzen for raising! We'll get this fixed up this week. If you'd like to open a PR to fix broken links you see, feel free and we can review, otherwise we'll get something out this week.