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

Add CI to check for dead links in docs #1579

Closed
alice-i-cecile opened this issue Mar 6, 2021 · 1 comment
Closed

Add CI to check for dead links in docs #1579

alice-i-cecile opened this issue Mar 6, 2021 · 1 comment
Labels
A-Build-System Related to build systems or continuous integration C-Docs An addition or correction to our documentation

Comments

@alice-i-cecile
Copy link
Member

What problem does this solve or what need does it fill?

cargo doc doesn't seem to emit errors if you point it to the wrong location in your docs link. This is going to be particularly painful to catch during large refactors of code structure.

This is also relevant for any external links we may use.

What solution would you like?

Add a task to the CI to ensure that all links within the docs point to a valid location.

What alternative(s) have you considered?

Wait for users to complain that the links are broken T_T

File a bug with cargo doc or find a way to configure it to show errors on dead links.

Additional context

Any other information you would like to add such as related previous work,
screenshots, benchmarks, etc.

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-Build-System Related to build systems or continuous integration labels Mar 6, 2021
@alice-i-cecile
Copy link
Member Author

Apparently there's a nice easy way to do this: https://github.com/deadlinks/cargo-deadlinks/

@bors bors bot closed this as completed in 391ccd0 Apr 22, 2021
ostwilkens pushed a commit to ostwilkens/bevy that referenced this issue Jul 27, 2021
Closes bevyengine#1579

This is my first contribution to this repository, feel free to correct anything that I'm missing and I'll address feedback as soon as possible!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Build-System Related to build systems or continuous integration C-Docs An addition or correction to our documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant