From e7dd9cb5ebb9e25600d7bd36c395ad42f302f472 Mon Sep 17 00:00:00 2001 From: "rtuli@redhat.com" Date: Tue, 2 Sep 2025 15:40:36 +0000 Subject: [PATCH] Fix documentation link checker errors 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: rtuli@redhat.com Signed-off-by: Rahul Tuli --- docs/developer/branding.md | 32 ++++++++++++++++---------------- docs/index.md | 8 ++++---- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/developer/branding.md b/docs/developer/branding.md index a31e2c11..08f83d1e 100644 --- a/docs/developer/branding.md +++ b/docs/developer/branding.md @@ -2,9 +2,9 @@
- - - Speculators logo + + + Speculators logo
@@ -39,19 +39,19 @@ All files reside in `docs/assets/branding`. | Category | Variant / Name | SVG | PNG | Notes | | -------- | -------------- | --- | --- | ----- | -| Logo | Black | [`speculators-logo-black.svg`](assets/branding/speculators-logo-black.svg) | [`speculators-logo-black.png`](assets/branding/speculators-logo-black.png) | Default on light backgrounds | -| Logo | Blue | [`speculators-logo-blue.svg`](assets/branding/speculators-logo-blue.svg) | [`speculators-logo-blue.png`](assets/branding/speculators-logo-blue.png) | Accent / section headers | -| Logo | White | [`speculators-logo-white.svg`](assets/branding/speculators-logo-white.svg) | [`speculators-logo-white.png`](assets/branding/speculators-logo-white.png) | Use on dark imagery/backgrounds | -| Icon | Black | [`speculators-icon-black.svg`](assets/branding/speculators-icon-black.svg) | [`speculators-icon-black.png`](assets/branding/speculators-icon-black.png) | App tile / light UI | -| Icon | Blue | [`speculators-icon-blue.svg`](assets/branding/speculators-icon-blue.svg) | [`speculators-icon-blue.png`](assets/branding/speculators-icon-blue.png) | Accent | -| Icon | White | [`speculators-icon-white.svg`](assets/branding/speculators-icon-white.svg) | [`speculators-icon-white.png`](assets/branding/speculators-icon-white.png) | Dark backgrounds | -| Icon | White-Orange | [`speculators-icon-white-orange.svg`](assets/branding/speculators-icon-white-orange.svg) | [`speculators-icon-white-orange.png`](assets/branding/speculators-icon-white-orange.png) | Limited highlight | -| Model Icon | Black | [`speculators-model-icon-black.svg`](assets/branding/speculators-model-icon-black.svg) | [`speculators-model-icon-black.png`](assets/branding/speculators-model-icon-black.png) | Architecture visuals | -| Model Icon | Blue | [`speculators-model-icon-blue.svg`](assets/branding/speculators-model-icon-blue.svg) | [`speculators-model-icon-blue.png`](assets/branding/speculators-model-icon-blue.png) | Architecture visuals | -| Model Icon | White | [`speculators-model-icon-white.svg`](assets/branding/speculators-model-icon-white.svg) | [`speculators-model-icon-white.png`](assets/branding/speculators-model-icon-white.png) | Dark backgrounds | -| Model Icon | White-Orange | [`speculators-model-icon-white-orange.svg`](assets/branding/speculators-model-icon-white-orange.svg) | [`speculators-model-icon-white-orange.png`](assets/branding/speculators-model-icon-white-orange.png) | Highlight sparingly | -| Diagram | User Flow (Light) | [`speculators-user-flow-light.svg`](assets/branding/speculators-user-flow-light.svg) | [`speculators-user-flow-light.png`](assets/branding/speculators-user-flow-light.png) | Light docs / print | -| Diagram | User Flow (Dark) | [`speculators-user-flow-dark.svg`](assets/branding/speculators-user-flow-dark.svg) | [`speculators-user-flow-dark.png`](assets/branding/speculators-user-flow-dark.png) | Dark slides / sites | +| Logo | Black | [`speculators-logo-black.svg`](../assets/branding/speculators-logo-black.svg) | [`speculators-logo-black.png`](../assets/branding/speculators-logo-black.png) | Default on light backgrounds | +| Logo | Blue | [`speculators-logo-blue.svg`](../assets/branding/speculators-logo-blue.svg) | [`speculators-logo-blue.png`](../assets/branding/speculators-logo-blue.png) | Accent / section headers | +| Logo | White | [`speculators-logo-white.svg`](../assets/branding/speculators-logo-white.svg) | [`speculators-logo-white.png`](../assets/branding/speculators-logo-white.png) | Use on dark imagery/backgrounds | +| Icon | Black | [`speculators-icon-black.svg`](../assets/branding/speculators-icon-black.svg) | [`speculators-icon-black.png`](../assets/branding/speculators-icon-black.png) | App tile / light UI | +| Icon | Blue | [`speculators-icon-blue.svg`](../assets/branding/speculators-icon-blue.svg) | [`speculators-icon-blue.png`](../assets/branding/speculators-icon-blue.png) | Accent | +| Icon | White | [`speculators-icon-white.svg`](../assets/branding/speculators-icon-white.svg) | [`speculators-icon-white.png`](../assets/branding/speculators-icon-white.png) | Dark backgrounds | +| Icon | White-Orange | [`speculators-icon-white-orange.svg`](../assets/branding/speculators-icon-white-orange.svg) | [`speculators-icon-white-orange.png`](../assets/branding/speculators-icon-white-orange.png) | Limited highlight | +| Model Icon | Black | [`speculators-model-icon-black.svg`](../assets/branding/speculators-model-icon-black.svg) | [`speculators-model-icon-black.png`](../assets/branding/speculators-model-icon-black.png) | Architecture visuals | +| Model Icon | Blue | [`speculators-model-icon-blue.svg`](../assets/branding/speculators-model-icon-blue.svg) | [`speculators-model-icon-blue.png`](../assets/branding/speculators-model-icon-blue.png) | Architecture visuals | +| Model Icon | White | [`speculators-model-icon-white.svg`](../assets/branding/speculators-model-icon-white.svg) | [`speculators-model-icon-white.png`](../assets/branding/speculators-model-icon-white.png) | Dark backgrounds | +| Model Icon | White-Orange | [`speculators-model-icon-white-orange.svg`](../assets/branding/speculators-model-icon-white-orange.svg) | [`speculators-model-icon-white-orange.png`](../assets/branding/speculators-model-icon-white-orange.png) | Highlight sparingly | +| Diagram | User Flow (Light) | [`speculators-user-flow-light.svg`](../assets/branding/speculators-user-flow-light.svg) | [`speculators-user-flow-light.png`](../assets/branding/speculators-user-flow-light.png) | Light docs / print | +| Diagram | User Flow (Dark) | [`speculators-user-flow-dark.svg`](../assets/branding/speculators-user-flow-dark.svg) | [`speculators-user-flow-dark.png`](../assets/branding/speculators-user-flow-dark.png) | Dark slides / sites | ## Usage Guidelines diff --git a/docs/index.md b/docs/index.md index e41bbb62..e0f72913 100644 --- a/docs/index.md +++ b/docs/index.md @@ -48,13 +48,13 @@ Unified Library for Speculative Decoding: Build, Evaluate, and Deploy Faster LLM [:octicons-arrow-right-24: Entrypoints](./entrypoints/) -- :material-api:{ .lg .middle } API Reference + @@ -85,5 +85,5 @@ VLLM_USE_V1=1 vllm serve RedHatAI/Qwen3-8B-speculator.eagle3 Speculators includes prototype implementations of cutting-edge speculative decoding research: -- **[EAGLE 3](./research/eagle3/)**: Train Time Test method implementation for advanced token speculation -- **[HASS](./research/hass/)**: EAGLE 1 architecture variation using the HASS training method +- **EAGLE 3**: Train Time Test method implementation for advanced token speculation +- **HASS**: EAGLE 1 architecture variation using the HASS training method