search

noir-lang / noir

Noir is a domain specific language for zero knowledge proofs
https://noir-lang.org
Apache License 2.0
875 stars 189 forks source link

Docs contains dead links #3999

Closed github-actions[bot] closed 8 months ago

github-actions[bot] commented 9 months ago

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 links

TomAFrench commented 9 months ago

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 ec_baby_jubjub test here.

Let me know what you think on this and if there's anybody else that should be assigned to this.

signorecello commented 9 months ago

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?

TomAFrench commented 9 months ago

It's weird that this happens because supposedly the docusaurus build looks for dead links...

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.

critesjosh commented 9 months ago

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?

TomAFrench commented 9 months ago

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