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

[ci] add a link-checking job #293

Open
jameslamb opened this issue Jan 4, 2025 · 0 comments
Open

[ci] add a link-checking job #293

jameslamb opened this issue Jan 4, 2025 · 0 comments
Labels
doc Improvements or additions to documentation good first issue Good for newcomers maintenance Not a bug or feature

Comments

@jameslamb
Copy link
Owner

Description

A CI job that catches broken links in documentation should be added here.

Benefits of this work

Acceptance criteria

  • a CI job here automatically catches broken links
  • that job:
    • does not run as a pre-commit hook
    • does not run on every commit to every pull request
    • runs once a month, some time near the middle of the month
    • can be manually triggered (e.g. via GitHub Actions workflow_dispatch functionality)

Approach

Copying LightGBM's setup would be a good start:

But open to other suggestions if someone finding this wants to attempt it!

@jameslamb jameslamb added doc Improvements or additions to documentation good first issue Good for newcomers maintenance Not a bug or feature labels Jan 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation good first issue Good for newcomers maintenance Not a bug or feature
Projects
None yet
Development

No branches or pull requests

1 participant