Incorrect Links in Documentation Overview Section

[ridamadara]

On the Dulwich documentation website (https://www.dulwich.io/docs/), within the "Overview" section, there is a problem with two hyperlinks that are currently leading users to the incorrect locations:

• AUTHORS
• CONTRIBUTING

I am interested in contributing to this issue by rectifying these hyperlinks.

[jelmer]

See docs/index.txt for where these links come from; it's happening because we're including ../README.rst

[jelmer]

A possible resolution might be to replace the include with a different bit of text.

[ridamadara]

In this section of the README.rst, it's important to note that AUTHORS and <CONTRIBUTING.rst> are not functioning as regular web links but rather references to internal or local resources within the project. One potential solution to address this issue could be to replace these tags with direct web links to their respective GitHub pages. This solution would involve making relatively minor modifications to the README.rst file.

[jelmer]

Please keep this URLs relative - they shouldn't go to GitHub when dulwich' README is displayed elsewhere, and if you're viewing them in another branch it shouldn't take you back to master.

[ridamadara]

To address this concern, we can create a new file specifically for the website that mirrors the README content. Within this file, we'll include URLs specifically redirected to the master branch. This way, when users visit the documentation on the website, the URLs will work as intended.

[jelmer]

That sounds good