Skip to content

Commit dcbf24a

Browse files
authored
docs: added office hour links (#1888)
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" />
1 parent b43aabc commit dcbf24a

File tree

3 files changed

+37
-21
lines changed

3 files changed

+37
-21
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ Objective metrics, intelligent test generation, and data-driven insights for LLM
4040
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.
4141
Don't have a test dataset ready? We also do production-aligned test set generation.
4242

43+
> [!NOTE]
44+
> 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).
45+
4346
## Key Features
4447

4548
- 🎯 Objective Metrics: Evaluate your LLM applications with precision using both LLM-based and traditional metrics.

docs/extra/overrides/main.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{% extends "base.html" %}
2+
3+
{% block announce %}
4+
<!-- Add announcement here, including arbitrary HTML -->
5+
<div class="announce">
6+
<p>
7+
<strong>Ragas Office Hours</strong> - If you need help setting up Evals for your AI application, sign up for our
8+
Office Hours <a href="https://cal.com/team/ragas/office-hours">here</a>.
9+
</p>
10+
</div>
11+
{% endblock %}

mkdocs.yml

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -138,8 +138,27 @@ validation:
138138
# Material-Docs Theme
139139
theme:
140140
name: material
141+
custom_dir: docs/extra/overrides
141142
logo: _static/imgs/ragas-logo.png
142143
favicon: _static/favicon.ico
144+
features:
145+
- announce.dismiss
146+
- content.tabs.link
147+
- content.code.annotate
148+
- content.code.copy
149+
- announce.dismiss
150+
- navigation.tabs
151+
- navigation.path
152+
- navigation.instant
153+
- navigation.instant.prefetch
154+
- navigation.instant.preview
155+
- navigation.sections
156+
- navigation.top
157+
- navigation.tracking
158+
- navigation.indexes
159+
- navigation.footer
160+
- search.suggest
161+
- search.highlight
143162
palette:
144163
# Palette toggle for automatic mode
145164
- media: "(prefers-color-scheme)"
@@ -160,23 +179,7 @@ theme:
160179
toggle:
161180
icon: material/brightness-4
162181
name: Switch to system preference
163-
features:
164-
- content.tabs.link
165-
- content.code.annotate
166-
- content.code.copy
167-
- announce.dismiss
168-
- navigation.tabs
169-
- navigation.path
170-
- navigation.instant
171-
- navigation.instant.prefetch
172-
- navigation.instant.preview
173-
- navigation.sections
174-
- navigation.top
175-
- navigation.tracking
176-
- navigation.indexes
177-
- navigation.footer
178-
- search.suggest
179-
- search.highlight
182+
180183
markdown_extensions:
181184
- pymdownx.highlight:
182185
anchor_linenums: true
@@ -215,7 +218,6 @@ extra:
215218
property: !ENV GOOGLE_ANALYTICS_KEY
216219
plugins:
217220
- search
218-
- social
219221
- git-revision-date-localized:
220222
enabled: !ENV [MKDOCS_CI, false]
221223
enable_creation_date: true
@@ -238,9 +240,9 @@ plugins:
238240
show_signature_annotations: true
239241
signature_crossrefs: true
240242
- glightbox
241-
- gen-files:
242-
scripts:
243-
- docs/ipynb_to_md.py
243+
# - gen-files:
244+
# scripts:
245+
# - docs/ipynb_to_md.py
244246
extra_javascript:
245247
- _static/js/mathjax.js
246248
- _static/js/header_border.js

0 commit comments

Comments
 (0)