docs: replace repeated benchmark link suffix with per-test descriptions

[thomhurst]

Summary

• Replace repeated "Detailed performance analysis" trailing text on runtime benchmark index with concrete per-benchmark descriptions (matches the Methodology section).
• Centralized in process-benchmarks.js so CI regenerations keep the fix.

Test plan

• Verify /docs/benchmarks/ index shows distinct descriptions per benchmark.

[claude]

Code Review

Summary

This is a clean, focused documentation improvement. The change correctly centralizes the descriptions in the script so CI regenerations preserve the fix — good practice.

What's Good

• Replacing the generic "Detailed performance analysis" with concrete per-benchmark descriptions is a clear UX improvement for users navigating the benchmarks index.
• Centralizing in process-benchmarks.js is the right place — the generated index.md is just the artifact.
• The em dash (—) is typographically cleaner than a hyphen-dash.
• The graceful fallback RUNTIME_DESCRIPTIONS[testClass] ? ... : '' prevents hard failures if a new class isn't mapped.

One Concern: Silent Fallback for Unmapped Benchmarks

The fallback renders the entry with no description at all:

`- [${testClass}](./.md)${RUNTIME_DESCRIPTIONS[testClass] ? ` — ${RUNTIME_DESCRIPTIONS[testClass]}` : ''}`

If a future benchmark class (e.g. NetworkTests) is added without a corresponding entry in RUNTIME_DESCRIPTIONS, it will silently render as a bare link with no description. This could easily be missed in CI output.

Suggested improvement: Add a console.warn when a class has no mapped description, so the gap is visible in CI logs:

if (!RUNTIME_DESCRIPTIONS[testClass]) {
  console.warn(`⚠️  No description found for runtime benchmark: ${testClass}`);
}

This keeps the fallback behaviour (no hard failure) but makes the gap detectable. Alternatively, a default string like `'Performance benchmarks'" could be used instead of an empty fallback.

Verdict

The change is correct and improves the docs. The silent fallback is a minor maintainability risk worth addressing. Happy to approve once that warning (or a deliberate decision to leave it silent) is confirmed.

[codacy-production]

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity

Metric	Results
Complexity	0

View in Codacy

_{TIP This summary will be updated as you push new changes. Give us feedback}