Skip to content

Fix broken links#125

Merged
dsikka merged 1 commit intovllm-project:mainfrom
aireilly:update-mkdocs
Sep 12, 2025
Merged

Fix broken links#125
dsikka merged 1 commit intovllm-project:mainfrom
aireilly:update-mkdocs

Conversation

@aireilly
Copy link
Copy Markdown
Collaborator

@aireilly aireilly commented Sep 9, 2025

* Fixed lychee errors and added /reference/speculators to .lycheeignore.
* Removed the auto-issue job, too noisy and not helpful
* Moved the link check job to run on PR CI jobs, not main nightly

Fix broken link errors.

Note, CI won't complete for PRs from forks, not sure if this is intended 🤷

Copilot AI review requested due to automatic review settings September 9, 2025 08:16
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR removes the automatic issue creation functionality from the link checker CI job while maintaining the link checking itself. The change simplifies the workflow by removing the step that automatically creates GitHub issues when broken links are detected.

  • Removes the "Create Issues" step that automatically generates GitHub issues for link checker failures
  • Maintains the link checking functionality and failure detection
  • Keeps the manual failure step that exits with an error code when issues are found
Comments suppressed due to low confidence (1)

.github/workflows/main.yml:1

  • The error message still references "the created issue" but no issue is being created anymore. This should be updated to reference checking the workflow logs or output instead.
name: Main

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@aireilly aireilly force-pushed the update-mkdocs branch 2 times, most recently from 0cb15a2 to 7df6774 Compare September 9, 2025 08:26
Copy link
Copy Markdown
Collaborator

@markurtz markurtz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to keep the link checking CI on main/nightly. This is primarily because links on README.md or other places that need absolute references will not work until they are landed on main. Secondarily, adds one less job to wait on for PRs.

Towards the above, I think a nightly cadence would work best so we're not overloading main

@aireilly aireilly force-pushed the update-mkdocs branch 6 times, most recently from a562539 to 9e34efa Compare September 9, 2025 16:40
@aireilly
Copy link
Copy Markdown
Collaborator Author

aireilly commented Sep 9, 2025

I'd like to keep the link checking CI on main/nightly. This is primarily because links on README.md or other places that need absolute references will not work until they are landed on main. Secondarily, adds one less job to wait on for PRs.

Towards the above, I think a nightly cadence would work best so we're not overloading main

Feel free to override or close this

@aireilly
Copy link
Copy Markdown
Collaborator Author

@markurtz I think this current approach is a good balance, depending on whether we want the build to fail on broken link errors or pass with warnings.

@fynnsu
Copy link
Copy Markdown
Collaborator

fynnsu commented Sep 10, 2025

Offering this as an alternative to removing the nightly link checker.

Instead of opening a new issue each time, we just have a single issue which we add comments to.

@aireilly aireilly force-pushed the update-mkdocs branch 5 times, most recently from 49383b9 to 25f7a86 Compare September 11, 2025 11:40
@aireilly aireilly changed the title Remove the auto-issue link check CI job Sep 11, 2025
@aireilly
Copy link
Copy Markdown
Collaborator Author

I'm going to stay in my lane on this one. This PR now just fixes some broken links.

@aireilly aireilly force-pushed the update-mkdocs branch 3 times, most recently from 922e739 to 8ba7dea Compare September 11, 2025 12:40
Signed-off-by: Aidan Reilly <aireilly@redhat.com>
Copy link
Copy Markdown
Collaborator

@rahul-tuli rahul-tuli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thank you!

@dsikka dsikka merged commit 36501d5 into vllm-project:main Sep 12, 2025
11 of 12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

6 participants