Skip to content

Make benchmarks more prominent in docs - #1030

Merged
aantn merged 4 commits into
masterfrom
promote-benchmarks-in-docs
Oct 4, 2025
Merged

aantn merged 4 commits into
masterfrom
promote-benchmarks-in-docs

Conversation

@aantn

@aantn aantn commented Oct 4, 2025 •

Copy link
Copy Markdown
Collaborator

...by linking to them from the homepage and main menu.

Also:

  • change the order in which test results are sorted in benchmark, to make comparisons easier
  • update some docs and add doc pages that were written but missing from the index

@aantn
aantn requested a review from arikalon1 October 4, 2025 17:16
@coderabbitai

coderabbitai Bot commented Oct 4, 2025 •

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@aantn has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 54 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between ed743af and ecc1498.

📒 Files selected for processing (1)
  • docs/development/evaluations/adding-evals.md (2 hunks)

Walkthrough

Adds/updates documentation navigation and evaluation metadata, removes a mock-data doc, adds built-in toolset entries, adjusts evaluation guidance, and simplifies evaluation ordering in the report generator to alphabetical sorting.

Changes

Cohort / File(s) Summary
Docs navigation
docs/.nav.yml, docs/development/.nav.yml, docs/index.md
Adds "Benchmarks" to main nav (pointing to development/evaluations), removes the "Evaluations: evaluations" entry from development nav, and renames quick-start link label from "View Evaluations" to "View Benchmarks".
Evaluation history metadata
docs/development/evaluations/history/results_20250928_001434.md, docs/development/evaluations/history/results_20250930_085923.md, docs/development/evaluations/history/results_20250930_153753.md
Normalize title lines to date-only headers and add or update top metadata lines (Generated, Total Duration, Iterations, Judge model); body content unchanged.
Eval report generation sorting
scripts/generate_eval_report.py
Removed custom multi-criteria sort key and now sorts evaluation cases alphabetically (lexical) when building the heatmap.
Built-in toolsets nav & index
docs/data-sources/builtin-toolsets/.nav.yml, docs/data-sources/builtin-toolsets/index.md
Added two new toolset entries: Bash (bash.md) and Cilium (cilium.md) into built-in toolsets navigation and index.
Cilium doc formatting
docs/data-sources/builtin-toolsets/cilium.md
Converted several bolded troubleshooting headings into tertiary Markdown headings (###) and added surrounding blank lines; content steps unchanged.
Mock-data docs & evaluation guidance
docs/development/evaluations/adding-evals.md, docs/using-mock-data.md
Rewrote mock-generation guidance in adding-evals.md: renamed section to "Mock Data Usage", switched pytest examples to poetry run pytest, added guidelines and notes for mock vs live runs. Deleted docs/using-mock-data.md (file removed).

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant User
  participant Generator as generate_eval_report.py
  participant Files as Eval result files
  participant Output as Markdown heatmap

  User->>Generator: run script
  Generator->>Files: load evaluation entries
  Generator-->>Generator: collect all_evals
  alt previous: complex priority sort (removed)
    Generator-->>Generator: (old) apply multi-criteria priority sort
  else new:
    Generator-->>Generator: sort eval names alphabetically
  end
  Generator-->>Generator: sort models (existing logic)
  Generator->>Output: render heatmap/table using new ordering
  Output-->>User: report produced
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

Suggested reviewers

  • arikalon1
  • Sheeproid

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title Check ✅ Passed The title succinctly captures the primary goal of the changeset, which is to surface benchmarks more prominently in the documentation by updating navigation and homepage links, and it aligns with the main nav and index updates without unnecessary detail.
Description Check ✅ Passed The description clearly outlines the key changes, including linking benchmarks from the homepage and menu, adjusting the benchmark result sorting order, and updating or adding documentation pages, all of which directly correspond to the modifications in the pull request.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@aantn
aantn enabled auto-merge (squash) October 4, 2025 17:30

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 786e8c1 and ed743af.

📒 Files selected for processing (7)
  • docs/data-sources/builtin-toolsets/.nav.yml (1 hunks)
  • docs/data-sources/builtin-toolsets/cilium.md (1 hunks)
  • docs/data-sources/builtin-toolsets/index.md (1 hunks)
  • docs/development/.nav.yml (1 hunks)
  • docs/development/evaluations/adding-evals.md (2 hunks)
  • docs/index.md (1 hunks)
  • docs/using-mock-data.md (0 hunks)
💤 Files with no reviewable changes (1)
  • docs/using-mock-data.md
✅ Files skipped from review due to trivial changes (2)
  • docs/data-sources/builtin-toolsets/cilium.md
  • docs/development/.nav.yml
🧰 Additional context used
📓 Path-based instructions (1)
docs/**/*.md

📄 CodeRabbit inference engine (CLAUDE.md)

In MkDocs docs, always add a blank line between a header/bold text and a following list to render correctly

Files:

  • docs/index.md
  • docs/data-sources/builtin-toolsets/index.md
  • docs/development/evaluations/adding-evals.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Pre-commit checks
  • GitHub Check: llm_evals

Comment thread docs/development/evaluations/adding-evals.md
@github-actions

github-actions Bot commented Oct 4, 2025

Copy link
Copy Markdown
Contributor

Results of HolmesGPT evals

  • ask_holmes: 33/35 test cases were successful, 0 regressions, 1 setup failures
Test suite Test case Status
ask 01_how_many_pods ✅
ask 02_what_is_wrong_with_pod ✅
ask 04_related_k8s_events ✅
ask 05_image_version ✅
ask 09_crashpod ✅
ask 10_image_pull_backoff ✅
ask 110_k8s_events_image_pull ✅
ask 11_init_containers ✅
ask 13a_pending_node_selector_basic ✅
ask 14_pending_resources ✅
ask 15_failed_readiness_probe ✅
ask 17_oom_kill ✅
ask 19_detect_missing_app_details ✅
ask 20_long_log_file_search ✅
ask 24_misconfigured_pvc ✅
ask 24a_misconfigured_pvc_basic ✅
ask 28_permissions_error 🚧
ask 39_failed_toolset ✅
ask 41_setup_argo ✅
ask 42_dns_issues_steps_new_tools ⚠️
ask 43_current_datetime_from_prompt ✅
ask 45_fetch_deployment_logs_simple ✅
ask 51_logs_summarize_errors ✅
ask 53_logs_find_term ✅
ask 54_not_truncated_when_getting_pods ✅
ask 59_label_based_counting ✅
ask 60_count_less_than ✅
ask 61_exact_match_counting ✅
ask 63_fetch_error_logs_no_errors ✅
ask 79_configmap_mount_issue ✅
ask 83_secret_not_found ✅
ask 86_configmap_like_but_secret ✅
ask 93_calling_datadog[0] ✅
ask 93_calling_datadog[1] ✅
ask 93_calling_datadog[2] ✅

Legend

  • ✅ the test was successful
  • :minus: the test was skipped
  • ⚠️ the test failed but is known to be flaky or known to fail
  • 🚧 the test had a setup failure (not a code regression)
  • 🔧 the test failed due to mock data issues (not a code regression)
  • 🚫 the test was throttled by API rate limits/overload
  • ❌ the test failed and should be fixed before merging the PR

@aantn
aantn merged commit a6716a1 into master Oct 4, 2025
7 checks passed
@aantn
aantn deleted the promote-benchmarks-in-docs branch October 4, 2025 18:04
This was referenced Dec 27, 2025
@coderabbitai coderabbitai Bot mentioned this pull request Jan 29, 2026
@coderabbitai coderabbitai Bot mentioned this pull request Mar 15, 2026
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.

2 participants