Broken links at https://redis.github.io/jedis/

[ggivo]

Some links are broken on index page of https://redis.github.io/jedis/

Links that can not be resolved :

INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
             - advanced-usage.md
             - jedis-maven.md
WARNING -  Doc file 'index.md' contains a link './LICENSE.txt', but the target 'LICENSE.txt' is not found among documentation files.
INFO    -  Doc file 'index.md' contains an absolute link '/docs/jedis-maven.md', it was left as is.
WARNING -  Doc file 'index.md' contains a link 'docs/redisjson.md', but the target is not found among documentation files.
WARNING -  Doc file 'index.md' contains a link 'docs/redisearch.md', but the target is not found among documentation files.
WARNING -  Doc file 'index.md' contains a link 'docs/failover.md', but the target is not found among documentation files.
WARNING -  Doc file 'index.md' contains a link 'docs/advanced-usage.md', but the target is not found among documentation files.

Issue : mkdocs index.md includes root level README.md and links are relative to it,. Making them relative to mkdocs index.md, will break the links in README.md itself.

[SwapnaliY16]

Hello @ggivo, I'd like to work on this.

[ggivo]

@SwapnaliY16
Please feel free to work on it.

The issue I faced is that README.md is shared (e.g, It is the main README.md shown on Jedis github repo, and at the same time, it is used by the mkdocs tool when generating https://redis.github.io/jedis/. I couldn't find a proper syntax that will work in both places, so I'm not sure what the solution is here.

[SwapnaliY16]

Thank you @ggivo for the clarification! I understand the challenge of maintaining a README.md file for both GitHub and MkDocs. I will keep the README.md optimised for GitHub and update docs/index.md with relative links for MkDocs, maintaining both files separately. Feel free to let me know if you have any other preferences.

[SwapnaliY16]

Hello @ggivo, I have raised a PR for your review. Please let me know if you would like me to address the warning as well mentioned in #4285. i.e.,

WARNING -  Excluding 'README.md' from the site because it conflicts with 'index.md'.