Skip to content

Commit

Permalink
docs: added office hour links (#1888)
Browse files Browse the repository at this point in the history
adding the message in readme and doc site
<img width="897" alt="image"
src="https://github.com/user-attachments/assets/b35565c5-adea-4a0f-86aa-013e097713b8"
/>
  • Loading branch information
jjmachan authored Jan 29, 2025
1 parent b43aabc commit dcbf24a
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 21 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ Objective metrics, intelligent test generation, and data-driven insights for LLM
Ragas is your ultimate toolkit for evaluating and optimizing Large Language Model (LLM) applications. Say goodbye to time-consuming, subjective assessments and hello to data-driven, efficient evaluation workflows.
Don't have a test dataset ready? We also do production-aligned test set generation.

> [!NOTE]
> Need help setting up Evals for your AI application? We'd love to help! We are conducting Office Hours every week. You can sign up [here](https://cal.com/team/ragas/office-hours).
## Key Features

- 🎯 Objective Metrics: Evaluate your LLM applications with precision using both LLM-based and traditional metrics.
Expand Down
11 changes: 11 additions & 0 deletions docs/extra/overrides/main.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{% extends "base.html" %}

{% block announce %}
<!-- Add announcement here, including arbitrary HTML -->
<div class="announce">
<p>
<strong>Ragas Office Hours</strong> - If you need help setting up Evals for your AI application, sign up for our
Office Hours <a href="https://cal.com/team/ragas/office-hours">here</a>.
</p>
</div>
{% endblock %}
44 changes: 23 additions & 21 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,27 @@ validation:
# Material-Docs Theme
theme:
name: material
custom_dir: docs/extra/overrides
logo: _static/imgs/ragas-logo.png
favicon: _static/favicon.ico
features:
- announce.dismiss
- content.tabs.link
- content.code.annotate
- content.code.copy
- announce.dismiss
- navigation.tabs
- navigation.path
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.preview
- navigation.sections
- navigation.top
- navigation.tracking
- navigation.indexes
- navigation.footer
- search.suggest
- search.highlight
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
Expand All @@ -160,23 +179,7 @@ theme:
toggle:
icon: material/brightness-4
name: Switch to system preference
features:
- content.tabs.link
- content.code.annotate
- content.code.copy
- announce.dismiss
- navigation.tabs
- navigation.path
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.preview
- navigation.sections
- navigation.top
- navigation.tracking
- navigation.indexes
- navigation.footer
- search.suggest
- search.highlight

markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
Expand Down Expand Up @@ -215,7 +218,6 @@ extra:
property: !ENV GOOGLE_ANALYTICS_KEY
plugins:
- search
- social
- git-revision-date-localized:
enabled: !ENV [MKDOCS_CI, false]
enable_creation_date: true
Expand All @@ -238,9 +240,9 @@ plugins:
show_signature_annotations: true
signature_crossrefs: true
- glightbox
- gen-files:
scripts:
- docs/ipynb_to_md.py
# - gen-files:
# scripts:
# - docs/ipynb_to_md.py
extra_javascript:
- _static/js/mathjax.js
- _static/js/header_border.js
Expand Down

0 comments on commit dcbf24a

Please sign in to comment.