Skip to content

Commit ef7892c

Browse files
authored
docs: reorganize prompt evaluation guides in navigation (#2346)
## Issue Link / Problem Description - Issue: The `iterate_prompt.md` guide was incorrectly placed under Customizations β†’ General, when it actually demonstrates a complete application workflow for evaluating and improving prompts. - The navigation structure didn't logically group related prompt evaluation guides together. ## Changes Made - Moved `iterate_prompt.md` from `docs/howtos/customizations/` to `docs/howtos/applications/` - Created new "Prompt Evaluation" subsection under Applications in `mkdocs.yml` - Grouped both prompt evaluation guides together: - Iterate and Improve Prompts - Systematic Prompt Optimization - Updated `docs/howtos/applications/index.md` with the new Prompt Evaluation section - Removed misplaced entries from the Customizations section in `mkdocs.yml` - Fixed broken link (missing .md extension) for prompt_optimization in applications/index.md ## Testing ### How to Test - [x] Automated tests added/updated: Pre-commit hooks passed (formatting checks) - [x] Manual testing steps: 1. Build the documentation locally: `make build-docs` 2. Verify navigation structure shows "Prompt Evaluation" under Applications 3. Confirm both guides are accessible and properly linked 4. Verify no broken links in the navigation
1 parent 911a127 commit ef7892c

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

β€Ždocs/howtos/applications/index.mdβ€Ž

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,24 @@ Ragas in action. Examples of how to use Ragas in various applications and
44
usecases to solve problems you might encounter when you're building.
55

66

7+
## Prompt Evaluation
8+
9+
- [Iterate and Improve Prompts](iterate_prompt.md)
10+
- [Systematic Prompt Optimization](prompt_optimization.md)
11+
712
## Metrics
813

914
- [Debug LLM based metrics using tracing](_metrics_llm_calls.md)
1015
- [Evaluating Multi-turn Conversations](evaluating_multi_turn_conversations.md)
1116
- [Estimate cost of evaluation](_cost.md)
1217
- [Evaluations with Vertex AI models](vertexai_x_ragas.md)
13-
- [Systematic Approach for Prompt Optimization](prompt_optimization)
1418

15-
## Testset Generation:
19+
## Testset Generation
1620

1721
- [Single-hop Query Testset](singlehop_testset_gen.md)
1822

1923
## Benchmarking
24+
2025
- [Evaluate a New LLM For Your Use Case](benchmark_llm.md)
2126

2227
## RAG Evaluation
File renamed without changes.

β€Žmkdocs.ymlβ€Ž

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,14 +95,12 @@ nav:
9595
- Run Config: howtos/customizations/_run_config.md
9696
- Caching: howtos/customizations/_caching.md
9797
- Cancelling Tasks: howtos/customizations/cancellation.md
98-
- Iterate Prompts: howtos/customizations/iterate_prompt.md
9998
- Metrics:
10099
- Modify Prompts: howtos/customizations/metrics/_modifying-prompts-metrics.md
101100
- Adapt Metrics to Languages: howtos/customizations/metrics/_metrics_language_adaptation.md
102101
- Write your own Metrics: howtos/customizations/metrics/_write_your_own_metric.md
103102
- Write your own Metrics - (advanced): howtos/customizations/metrics/_write_your_own_metric_advanced.md
104103
- Train and Align Metrics: howtos/customizations/metrics/train_your_own_metric.md
105-
- Systematic Approach for Prompt Optimization: howtos/applications/prompt_optimization.md
106104
- Testset Generation:
107105
- Non-English Testset Generation: howtos/customizations/testgenerator/_language_adaptation.md
108106
- Persona Generation: howtos/customizations/testgenerator/_persona_generator.md
@@ -111,6 +109,9 @@ nav:
111109

112110
- Applications:
113111
- howtos/applications/index.md
112+
- Prompt Evaluation:
113+
- Iterate and Improve Prompts: howtos/applications/iterate_prompt.md
114+
- Systematic Prompt Optimization: howtos/applications/prompt_optimization.md
114115
- Metrics:
115116
- Cost Analysis: howtos/applications/_cost.md
116117
- Evaluating Multi-turn Conversations: howtos/applications/evaluating_multi_turn_conversations.md

0 commit comments

Comments
Β (0)