Skip to content

Conversation

rahul-tuli
Copy link
Collaborator

Summary

Resolves 32 broken file links identified by the nightly link checker workflow that were causing CI failures.

Root Cause

The documentation had two categories of broken links:

  1. Incorrect relative paths: Branding assets referenced from docs/developer/branding.md used relative paths that didn't account for the subdirectory structure
  2. Missing directories: Links to non-existent API documentation and research sections

Changes

Fixed Branding Asset Links

  • Updated all asset references in docs/developer/branding.md to use ../assets/branding/ instead of assets/branding/
  • Fixed both the header logo display and the asset catalog table links
  • All 26 branding assets (SVG/PNG files) exist but were incorrectly referenced

Removed Broken Directory Links

  • Commented out API Reference section in docs/index.md until API docs are created
  • Removed broken links to ./research/eagle3/ and ./research/hass/ directories
  • Converted research section items to plain text descriptions

Validation

  • All referenced branding assets verified to exist in docs/assets/branding/
  • Link paths tested to ensure proper relative traversal from subdirectories
  • Commented sections can be easily re-enabled when target directories are created

Impact

  • Fixes nightly CI link checker failures
  • Maintains documentation functionality while removing broken references
  • Preserves future extensibility for API docs and research sections

Resolved 32 broken file links identified by the nightly link checker:

1. Fixed relative paths in docs/developer/branding.md by adding ../ prefix
   to correctly reference branding assets from the subdirectory
2. Commented out broken API reference link in docs/index.md
3. Removed broken research directory links for eagle3 and hass sections

All branding assets exist in docs/assets/branding/ but were incorrectly
referenced without proper relative path traversal from the developer/
subdirectory.

Fixes link checker failures in nightly CI workflow.

Signed-off-by: [email protected] <[email protected]>
Signed-off-by: Rahul Tuli <[email protected]>
@Copilot Copilot AI review requested due to automatic review settings September 2, 2025 15:40
Copy link
Contributor

@Copilot 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 fixes broken documentation links that were causing CI failures in the nightly link checker workflow. The fixes address incorrect relative paths to branding assets and remove references to non-existent documentation directories.

  • Updated relative paths for branding assets from assets/branding/ to ../assets/branding/
  • Commented out the API Reference section until API documentation is created
  • Converted broken research section links to plain text descriptions

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/index.md Commented out API Reference section and converted research links to plain text
docs/developer/branding.md Fixed relative paths for all branding asset references

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

Copy link

github-actions bot commented Sep 2, 2025

📦 Build Artifacts Available
The build artifacts (`.whl` and `.tar.gz`) have been successfully generated and are available for download: https://github.com/vllm-project/speculators/actions/runs/17409603676/artifacts/3908217672.
They will be retained for up to 30 days.
Commit: bb6164c

Copy link
Collaborator

@dsikka dsikka left a comment

Choose a reason for hiding this comment

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

This doesn’t break our docs, does it?

@dsikka dsikka requested a review from aireilly September 2, 2025 15:44
@rahul-tuli rahul-tuli marked this pull request as draft September 2, 2025 15:50
@rahul-tuli
Copy link
Collaborator Author

This doesn’t break our docs, does it?

I will double check before requesting a review, this PR is Claude-generated!

@aireilly
Copy link
Collaborator

aireilly commented Sep 3, 2025

Maybe cleaner to set this in mkdocs.yml instead?

https://www.mkdocs.org/user-guide/configuration/#validation-of-absolute-links

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants