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

Some links in the documentation seem to be broken #288

Closed
mtakeshi1 opened this issue Mar 27, 2023 · 3 comments
Closed

Some links in the documentation seem to be broken #288

mtakeshi1 opened this issue Mar 27, 2023 · 3 comments
Labels
bug Something isn't working

Comments

@mtakeshi1
Copy link

Bug description

Hi.

First of all, if it's not the right way to report issues like this, I apologize in advance. In the getting_started.md file, the links for the installation and compilation are wrong (or the sections that they refer to):

[Installation on GNU/Linux](installation_linux.md) section.

should be

[Installation on GNU/Linux](installation-linux.md) section.

as the same goes for the other links.

I did clone the documentation and re-generated it with the right links, but since the misspelling originated in the main project, I was not sure how to proceed. In any case, I'm more than happy to create the PR to fix these, I just need some pointers as to where should I create the PR.

To Reproduce

  1. Navigate to: Getting Started
  2. Click on any of the 4 top links

Expected behavior

You should be redirected to the corresponding section.

Screenshots

Environment

  • Any browser

Additional context

@mtakeshi1 mtakeshi1 added the bug Something isn't working label Mar 27, 2023
@demeringo
Copy link
Contributor

@mtakeshi1 thank you for highlighting this.

Maybe we should automate link check at compile time. I did some tests with a mdbook link-checker plugin for another project.
I ended up deactivating it in CI (I encountered a minor side effect at the time and I never took the time to configure it properly, but I should probably have a second look now...).
https://github.com/Boavizta/cloud-scanner/blob/f4d2617b6c7e37cb5c0b9f8c53888fbe02bd66e4/docs/book.toml#L8

The checker used was:
https://github.com/Michael-F-Bryan/mdbook-linkcheck .

@demeringo
Copy link
Contributor

Also, I notice that #259 is proposing similar solution.

@bpetit
Copy link
Contributor

bpetit commented Apr 11, 2023

Should I close this one as #259 is merged ? Or should it be the starting point to automate checks on the doc ?

@bpetit bpetit closed this as completed May 11, 2023
@bpetit bpetit added this to General Jun 19, 2024
@bpetit bpetit moved this to Previous releases in General Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: Previous releases
Development

No branches or pull requests

3 participants