rename README.md to index.md, to avoid broken link alerts

[tshepang]

mdbook renders README.md files as index.html, so linking to README.md results in 404 errors.

Rendered

[rustbot]

r? @jieyouxu

rustbot has assigned @jieyouxu.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

[apiraino]

Can you show an example of broken link alert?

[tshepang]

I got it locally when I tried linking to one of the README.md files, so I did not submit the change as a result, and instead made this change

[apiraino]

I got it locally when I tried linking to one the README.md files

I'm sorry, I still don't understand the issue you've found. What kind of linking are you referring to? Between Markdown files? Can you guide me with a concrete step-by-step example?

Thanks

[jieyouxu]

I feel like this is an mdbook configuration issue 🤔

[jieyouxu]

EDIT: https://rust-lang.github.io/mdBook/format/configuration/preprocessors.html#configuring-preprocessors

EDIT 2: Wait, is this actually the linkchecker's problem?

[ehuss]

This is an issue in mdbook (rust-lang/mdBook#984). It automatically converts pages called README.md to index.html. However, it does not convert links to pages like [foo](README.md) to index.html, and thus those links don't work.

There are two workarounds, one is to rename files to index.md, or the other is to link to index.md in the source. I'm not sure which is the most reasonable here.

[apiraino]

This is an issue in mdbook (rust-lang/mdBook#984).

Ah yes, that link is really appreciated, now I get it. So, all the linked PRs to that issue indicates that people are renaming files, which imho is a bit ugly (but now I understand the reasoning).

I looked in the mdbook repo and there seems to be a stalled WIP patch, mdBook#1921. @ehuss I didn't look deep into that, do you think that patch goes in the right direction (I've read your review)?

[jieyouxu]

I think it's more important that links are fixed, renaming seems fine