Skip to content

chore(docs): fix API docs link button to bypass SPA routing#1384

Merged
tobz merged 1 commit into
mainfrom
tobz/fix-api-docs-link
Apr 14, 2026
Merged

chore(docs): fix API docs link button to bypass SPA routing#1384
tobz merged 1 commit into
mainfrom
tobz/fix-api-docs-link

Conversation

@tobz
Copy link
Copy Markdown
Member

@tobz tobz commented Apr 14, 2026

Summary

This PR fixes an issue with the Saluki docs where the API Documentation button, meant to navigate to the generated rustdocs, would fail to do so by it would be intercepted by Vitepress's SPA router. In #1278, we tried to add a placeholder file to make Vitepress happier and fix this, but to no avail.

In this PR, we set the target of the link element, which causes Vitepress to ignore intercepting the link in its router, letting it function as a regular ol' link. We've left the placeholder page added in #1278 because it's actually very helpful/informative to see when running the docs dev server, as it explains exactly how to generate the rustdoc content to then preview it locally.

Change Type

  • Bug fix
  • New feature
  • Non-functional (chore, refactoring, docs)
  • Performance

How did you test this PR?

Ran bun run docs:dev and ensured the placeholder page remained, and then generated the rustdocs, built the production site (bun run docs:build), and copied the rustdoc output on top as we do in CI, and finally ran bun run docs:preview to observe the built production site, verifying that clicking the button took me to the actual generated rustdocs.

References

AGTMETRICS-400

Fixes #1376.

Copy link
Copy Markdown
Member Author

tobz commented Apr 14, 2026

This stack of pull requests is managed by Graphite. Learn more about stacking.

@dd-octo-sts dd-octo-sts Bot added the area/docs Reference documentation. label Apr 14, 2026
@pr-commenter
Copy link
Copy Markdown

pr-commenter Bot commented Apr 14, 2026

Binary Size Analysis (Agent Data Plane)

Target: 1f8a8a3 (baseline) vs 92aabc2 (comparison) diff
Analysis Type: Stripped binaries (debug symbols excluded)
Baseline Size: 36.08 MiB
Comparison Size: 36.08 MiB
Size Change: +0 B (+0.00%)
Pass/Fail Threshold: +5%
Result: PASSED ✅

Changes by Module

Module File Size Symbols
anon.4f8fd67d74ae1f1600187cfeb0121be9.1.llvm.6972256261814945635 +129 B 1
anon.4f8fd67d74ae1f1600187cfeb0121be9.1.llvm.7872870264723952264 -129 B 1
anon.4f8fd67d74ae1f1600187cfeb0121be9.4.llvm.6972256261814945635 +114 B 1
anon.4f8fd67d74ae1f1600187cfeb0121be9.4.llvm.7872870264723952264 -114 B 1
anon.4f8fd67d74ae1f1600187cfeb0121be9.3.llvm.6972256261814945635 +108 B 1
anon.4f8fd67d74ae1f1600187cfeb0121be9.3.llvm.7872870264723952264 -108 B 1
anon.4f8fd67d74ae1f1600187cfeb0121be9.0.llvm.6972256261814945635 +96 B 1
anon.4f8fd67d74ae1f1600187cfeb0121be9.0.llvm.7872870264723952264 -96 B 1
anon.4f8fd67d74ae1f1600187cfeb0121be9.2.llvm.6972256261814945635 +94 B 1
anon.4f8fd67d74ae1f1600187cfeb0121be9.2.llvm.7872870264723952264 -94 B 1

Detailed Symbol Changes

    FILE SIZE        VM SIZE    
 --------------  -------------- 
  [NEW]    +129  [NEW]     +40    anon.4f8fd67d74ae1f1600187cfeb0121be9.1.llvm.6972256261814945635
  [NEW]    +114  [NEW]     +25    anon.4f8fd67d74ae1f1600187cfeb0121be9.4.llvm.6972256261814945635
  [NEW]    +108  [NEW]     +19    anon.4f8fd67d74ae1f1600187cfeb0121be9.3.llvm.6972256261814945635
  [NEW]     +96  [NEW]      +7    anon.4f8fd67d74ae1f1600187cfeb0121be9.0.llvm.6972256261814945635
  [NEW]     +94  [NEW]      +5    anon.4f8fd67d74ae1f1600187cfeb0121be9.2.llvm.6972256261814945635
  [DEL]     -94  [DEL]      -5    anon.4f8fd67d74ae1f1600187cfeb0121be9.2.llvm.7872870264723952264
  [DEL]     -96  [DEL]      -7    anon.4f8fd67d74ae1f1600187cfeb0121be9.0.llvm.7872870264723952264
  [DEL]    -108  [DEL]     -19    anon.4f8fd67d74ae1f1600187cfeb0121be9.3.llvm.7872870264723952264
  [DEL]    -114  [DEL]     -25    anon.4f8fd67d74ae1f1600187cfeb0121be9.4.llvm.7872870264723952264
  [DEL]    -129  [DEL]     -40    anon.4f8fd67d74ae1f1600187cfeb0121be9.1.llvm.7872870264723952264
  [ = ]       0  [ = ]       0    TOTAL

@tobz tobz added the type/bug Bug fixes. label Apr 14, 2026
@tobz tobz marked this pull request as ready for review April 14, 2026 19:29
@tobz tobz requested a review from a team as a code owner April 14, 2026 19:29
@pr-commenter
Copy link
Copy Markdown

pr-commenter Bot commented Apr 14, 2026

Regression Detector (Agent Data Plane)

Regression Detector Results

Run ID: 07f98f54-8087-4c17-80e8-91c17dde9d6e

Baseline: 1f8a8a3
Comparison: 92aabc2
Diff

Optimization Goals: ✅ No significant changes detected

Experiments ignored for regressions

Regressions in experiments with settings containing erratic: true are ignored.

perf experiment goal Δ mean % Δ mean % CI trials links
otlp_ingest_logs_5mb_memory memory utilization +1.54 [+1.36, +1.73] 1 (metrics) (profiles) (logs)
otlp_ingest_logs_5mb_cpu % cpu utilization +0.76 [-3.80, +5.32] 1 (metrics) (profiles) (logs)
otlp_ingest_logs_5mb_throughput ingress throughput +0.03 [-0.10, +0.16] 1 (metrics) (profiles) (logs)

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
dsd_uds_1mb_3k_contexts_cpu % cpu utilization +6.31 [-49.00, +61.63] 1 (metrics) (profiles) (logs)
dsd_uds_100mb_3k_contexts_cpu % cpu utilization +2.65 [-3.12, +8.41] 1 (metrics) (profiles) (logs)
otlp_ingest_traces_ottl_filtering_5mb_cpu % cpu utilization +2.26 [+0.01, +4.51] 1 (metrics) (profiles) (logs)
otlp_ingest_metrics_5mb_memory memory utilization +1.73 [+1.59, +1.86] 1 (metrics) (profiles) (logs)
otlp_ingest_logs_5mb_memory memory utilization +1.54 [+1.36, +1.73] 1 (metrics) (profiles) (logs)
otlp_ingest_metrics_5mb_cpu % cpu utilization +1.26 [-4.34, +6.86] 1 (metrics) (profiles) (logs)
otlp_ingest_logs_5mb_cpu % cpu utilization +0.76 [-3.80, +5.32] 1 (metrics) (profiles) (logs)
dsd_uds_10mb_3k_contexts_cpu % cpu utilization +0.62 [-30.52, +31.75] 1 (metrics) (profiles) (logs)
quality_gates_rss_dsd_medium memory utilization +0.32 [+0.15, +0.49] 1 (metrics) (profiles) (logs)
otlp_ingest_traces_5mb_memory memory utilization +0.19 [-0.03, +0.40] 1 (metrics) (profiles) (logs)
dsd_uds_500mb_3k_contexts_throughput ingress throughput +0.15 [+0.01, +0.30] 1 (metrics) (profiles) (logs)
quality_gates_rss_dsd_ultraheavy memory utilization +0.12 [-0.01, +0.24] 1 (metrics) (profiles) (logs)
quality_gates_rss_dsd_heavy memory utilization +0.11 [-0.03, +0.24] 1 (metrics) (profiles) (logs)
otlp_ingest_logs_5mb_throughput ingress throughput +0.03 [-0.10, +0.16] 1 (metrics) (profiles) (logs)
dsd_uds_10mb_3k_contexts_memory memory utilization +0.03 [-0.13, +0.19] 1 (metrics) (profiles) (logs)
dsd_uds_100mb_3k_contexts_throughput ingress throughput +0.01 [-0.01, +0.03] 1 (metrics) (profiles) (logs)
dsd_uds_10mb_3k_contexts_throughput ingress throughput +0.00 [-0.15, +0.16] 1 (metrics) (profiles) (logs)
dsd_uds_512kb_3k_contexts_throughput ingress throughput +0.00 [-0.05, +0.06] 1 (metrics) (profiles) (logs)
otlp_ingest_traces_ottl_filtering_5mb_throughput ingress throughput +0.00 [-0.02, +0.02] 1 (metrics) (profiles) (logs)
dsd_uds_1mb_3k_contexts_throughput ingress throughput -0.00 [-0.06, +0.06] 1 (metrics) (profiles) (logs)
otlp_ingest_traces_5mb_throughput ingress throughput -0.00 [-0.02, +0.02] 1 (metrics) (profiles) (logs)
otlp_ingest_traces_ottl_transform_5mb_throughput ingress throughput -0.00 [-0.02, +0.02] 1 (metrics) (profiles) (logs)
otlp_ingest_metrics_5mb_throughput ingress throughput -0.01 [-0.14, +0.13] 1 (metrics) (profiles) (logs)
quality_gates_rss_dsd_low memory utilization -0.01 [-0.18, +0.16] 1 (metrics) (profiles) (logs)
dsd_uds_100mb_3k_contexts_memory memory utilization -0.01 [-0.17, +0.14] 1 (metrics) (profiles) (logs)
dsd_uds_512kb_3k_contexts_memory memory utilization -0.01 [-0.16, +0.13] 1 (metrics) (profiles) (logs)
dsd_uds_1mb_3k_contexts_memory memory utilization -0.05 [-0.19, +0.10] 1 (metrics) (profiles) (logs)
otlp_ingest_traces_ottl_filtering_5mb_memory memory utilization -0.08 [-0.38, +0.21] 1 (metrics) (profiles) (logs)
dsd_uds_500mb_3k_contexts_memory memory utilization -0.09 [-0.23, +0.06] 1 (metrics) (profiles) (logs)
otlp_ingest_traces_ottl_transform_5mb_memory memory utilization -0.22 [-0.42, -0.01] 1 (metrics) (profiles) (logs)
dsd_uds_500mb_3k_contexts_cpu % cpu utilization -0.26 [-1.63, +1.12] 1 (metrics) (profiles) (logs)
quality_gates_rss_idle memory utilization -0.27 [-0.30, -0.24] 1 (metrics) (profiles) (logs)
otlp_ingest_traces_ottl_transform_5mb_cpu % cpu utilization -1.24 [-3.36, +0.89] 1 (metrics) (profiles) (logs)
dsd_uds_512kb_3k_contexts_cpu % cpu utilization -1.26 [-57.08, +54.56] 1 (metrics) (profiles) (logs)
otlp_ingest_traces_5mb_cpu % cpu utilization -3.55 [-5.42, -1.68] 1 (metrics) (profiles) (logs)

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed observed_value links
quality_gates_rss_dsd_heavy memory_usage 10/10 119.16MiB ≤ 140MiB (metrics) (profiles) (logs)
quality_gates_rss_dsd_low memory_usage 10/10 39.00MiB ≤ 50MiB (metrics) (profiles) (logs)
quality_gates_rss_dsd_medium memory_usage 10/10 59.57MiB ≤ 75MiB (metrics) (profiles) (logs)
quality_gates_rss_dsd_ultraheavy memory_usage 10/10 176.14MiB ≤ 200MiB (metrics) (profiles) (logs)
quality_gates_rss_idle memory_usage 10/10 26.46MiB ≤ 40MiB (metrics) (profiles) (logs)

Explanation

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

Performance changes are noted in the perf column of each table:

  • ✅ = significantly better comparison variant performance
  • ❌ = significantly worse comparison variant performance
  • ➖ = no significant change in performance

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

  3. Its configuration does not mark it "erratic".

@tobz tobz merged commit e865068 into main Apr 14, 2026
65 checks passed
@tobz tobz deleted the tobz/fix-api-docs-link branch April 14, 2026 19:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Reference documentation. type/bug Bug fixes.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix ongoing issues with the vitepress API Documentation button.

2 participants