Skip to content

Conversation

@bbalakriz
Copy link

@bbalakriz bbalakriz commented Oct 9, 2025

Description

This PR updates the documentation to improve the clarity and accuracy of URLs, so that users can directly click on the links without confusion and that the documentation is more accessible. Specifically, it:

How Has This Been Tested?

  • The changes were reviewed manually to ensure that all URL links are now fully-qualified.
  • No functionality was impacted by these changes, as they are purely documentation updates.
  • Verified that the URLs work properly in the rendered version of the documentation.

Merge criteria:

  • [ X] The commits are squashed in a cohesive manner and have meaningful messages.
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • [ X] The developer has manually tested the changes and verified that the changes work

Summary by CodeRabbit

  • Documentation
    • Updated documentation links to use full HTTPS URLs for external resources (e.g., Unitxt and model pages), improving reliability, security, and ease of navigation.
    • Standardized link formatting for consistency across the page.
    • Performed minor formatting cleanup without altering instructional content or examples.
    • No functional changes to features or workflows; content remains the same, now with clearer, fully qualified references.

Fixed AsciiDoc syntax errors for broken links in document
@coderabbitai
Copy link

coderabbitai bot commented Oct 9, 2025

Walkthrough

Replaced URL-style link references in one AsciiDoc file with fully qualified HTTPS URLs, keeping all other content unchanged.

Changes

Cohort / File(s) Summary
Docs link normalization
modules/using-llm-as-a-judge-metrics-with-lmeval.adoc
Converted inline links to absolute HTTPS URLs for Unitxt and Hugging Face model references; no content or structural changes otherwise.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title Check ⚠️ Warning The title refers to “broker URL formatting” which does not appear in the changeset, as the pull request actually updates documentation links to fully qualified URLs for various models. This mismatch makes the title misleading and fails to accurately summarize the main change. Reviewers scanning the history would not understand the true scope from the current title. Rename the title to clearly describe the documentation updates, for example “Fix documentation link formatting to use fully qualified URLs,” so that it accurately reflects replacing relative model links with absolute URLs. Remove the incorrect “broker” term to avoid confusion and ensure concise, informative phrasing.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
modules/using-llm-as-a-judge-metrics-with-lmeval.adoc (1)

20-20: Add trailing carets to external links and update PR title

  • Line 20: change link:…[Unitxt], …[flan-t5-small], …[Mistral-7B] to include ^ for new-tab consistency.
  • Optional: run a repo-wide scan for link:http://, link:www., or link:https?://…[…](?!\^).
  • Align the PR title to reflect link normalization instead of “broker URL.”
-This example uses link:https://www.unitxt.ai[Unitxt] to define custom metrics and to see how the model (link:https://www.huggingface.co/google/flan-t5-small[flan-t5-small]) answers questions from MT-Bench, a standard benchmark. Custom evaluation criteria and instructions from the link:https://www.huggingface.co/mistralai/Mistral-7B-Instruct-v0.2[Mistral-7B] model are used to rate the answers from 1-10, based on helpfulness, accuracy, and detail.
+This example uses link:https://www.unitxt.ai[Unitxt^] to define custom metrics and to see how the model (link:https://www.huggingface.co/google/flan-t5-small[flan-t5-small^]) answers questions from MT-Bench, a standard benchmark. Custom evaluation criteria and instructions from the link:https://www.huggingface.co/mistralai/Mistral-7B-Instruct-v0.2[Mistral-7B^] model are used to rate the answers from 1-10, based on helpfulness, accuracy, and detail.
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between adf4500 and 7a540d8.

📒 Files selected for processing (1)
  • modules/using-llm-as-a-judge-metrics-with-lmeval.adoc (2 hunks)
🔇 Additional comments (1)
modules/using-llm-as-a-judge-metrics-with-lmeval.adoc (1)

236-236: LGTM

No issues; text reads clearly and remains accurate.

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.

1 participant