Docs contains dead links #3999
Comments
github-actions
bot
added
the
documentation
|
Hi @signorecello! I've made a CI workflow which I think would be helpful. It automates checking for dead links in the docs and creates an issue if any exist. You can take a look at it here #3992 As an example of one it's found, there's the link to the Let me know what you think on this and if there's anybody else that should be assigned to this. |
|
Hey looks good! It's weird that this happens because supposedly the docusaurus build looks for dead links... But it's true we've seen some dead links around specially if they're not inside the docs pages. Can the workflow assign the whole @noir-lang/developerrelations team please? |
Docusaurus only checks internal links as otherwise it would have to make network calls to determine the health of the links. Internal ones it can do by just checking that the relevant file exists. |
|
I get a 404 for the link that the bot provided (https://github.com/noir-lang/noir/actions/runs/7553342449/job/markdown-link-check). Does it work for you? Could we add this to the Aztec docs as well? |
|
Ah, looks like it's injecting the name of the job rather than its id. The link should point to: https://github.com/noir-lang/noir/actions/runs/7553342449/job/20563972786 |
# Description ## Problem\* Resolves <!-- Link to GitHub Issue --> ## Summary\* As @critesjosh mentioned in #3999, this link currently 404s because github doesn't allow getting the job id necessary to construct this URL using the context api. ## Additional Context ## Documentation\* Check one: - [x] No documentation needed. - [ ] Documentation included in this PR. - [ ] **[Exceptional Case]** Documentation to be submitted in a separate PR. # PR Checklist\* - [x] I have tested the changes locally. - [x] I have formatted the changes with [Prettier](https://prettier.io/) and/or `cargo fmt` on default settings.
# Description ## Problem\* Resolves #3999 ## Summary\* This PR fixes a bunch of cases of dead links where the target has been moved or in one case never existed in the first place. ## Additional Context ## Documentation\* Check one: - [ ] No documentation needed. - [x] Documentation included in this PR. - [ ] **[Exceptional Case]** Documentation to be submitted in a separate PR. # PR Checklist\* - [x] I have tested the changes locally. - [x] I have formatted the changes with [Prettier](https://prettier.io/) and/or `cargo fmt` on default settings.
Some of the external links in the docs are now dead. This is likely due to the thing being linked to being moved.
Check the Check Markdown links workflow for details.
This issue was raised by the workflow
Check Markdown linksThe text was updated successfully, but these errors were encountered: