Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Broken links in docs (Introduction -> Grow your skills) #1130

Closed
kpalf opened this issue May 5, 2022 · 5 comments
Closed

Broken links in docs (Introduction -> Grow your skills) #1130

kpalf opened this issue May 5, 2022 · 5 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@kpalf
Copy link

kpalf commented May 5, 2022

Is your documentation request related to a problem? Please describe.
Documentation as seen at 5 May 2022 has 4 broken links (404 result) on the following page:
https://thin-edge.github.io/thin-edge.io/html/001_overview.html
All 4 links in the bottom section, "Grow your skills". Each of them references a different README, but none are resolved.

@kpalf
Copy link
Author

kpalf commented May 5, 2022

Same README links also broken from https://thin-edge.github.io/thin-edge.io/html/SUMMARY.html

@rina23q rina23q added bug Something isn't working documentation Improvements or additions to documentation labels May 5, 2022
@rina23q
Copy link
Member

rina23q commented May 5, 2022

It's caused by the issue that was reported in the mdbook repository. rust-lang/mdBook#984

mdbook preprocessing,

index: Convert all chapter files named README.md into index.md. That is to say, all README.md would be rendered to an index file index.html in the rendered book.

@rina23q
Copy link
Member

rina23q commented May 6, 2022

Rename all README.md in the subdirectories to better names, such as tutorials, howto-guides, etc. And fix the links.

@didier-wenzek
Copy link
Contributor

The point to have these files README.md and not index.md is to be able to browse the documentation directly on github without having to build it.

@rina23q rina23q self-assigned this May 24, 2022
@rina23q rina23q mentioned this issue May 24, 2022
11 tasks
@rina23q
Copy link
Member

rina23q commented May 31, 2022

I confirmed #1162 fixed the broken links. Therefore, I'd like to close this issue.

@rina23q rina23q closed this as completed May 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants