docs: Update documentation structure to reflect experiments-first paradigm #2394
+59
−131
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dosubot
bot
added
the
size:L
… messaging - Add 'Why Ragas?' section explaining value proposition - Update key features to emphasize experiments-first approach and custom metrics - Remove FAQ section (moved to how-to guides) - Improve card descriptions to be more actionable - Update Get Started link to point to experiments quickstart
- Move experiments quickstart to prominent Quickstart section - Remove links to old RAG-focused tutorials (evals.md, rag_eval.md, rag_testset_generation.md) - Organize tutorials into separate section with clearer descriptions - Add Discord community link - Update structure to emphasize experiments-first approach
- Move Experimentation and Datasets to the top with separate cards - Update metrics description to mention both available and custom metrics - Remove Feedback Intelligence card from index - Move Components to the end - Reorder to match new experiments-first paradigm
- Remove old RAG-focused tutorials from Get Started navigation - Flatten Experiments section: Experimentation and Datasets as direct children - Remove Feedback Intelligence from Core Concepts navigation - Move Components section to after Test Data Generation - Reorganize Get Started to prioritize experiments quickstart - Update structure to match new documentation organization
sanjeed5
force-pushed
the
docs/restructure-for-experiments
branch
from
99c74be to
f054514
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem Description:
Documentation structure was outdated and didn't reflect the current library focus on experiments and custom metrics. The library has evolved to emphasize systematic experimentation and custom metrics for evaluating any AI application.
Changes Made
Home page (
docs/index.md): Added "Why Ragas?" section explaining value proposition and key features. Updated to reflect experiments-first approach, custom metrics, and broader AI application evaluation. Removed FAQ section and improved card descriptions to be more actionable.Get Started (
docs/getstarted/index.md): Reorganized to reflect experiments quickstart as the main entry point. Removed links to outdated RAG-focused tutorials (evals.md, rag_eval.md, rag_testset_generation.md). Added Discord community link and organized tutorials into clearer sections.Core Concepts (
docs/concepts/index.md): Reordered sections to prioritize Experimentation and Datasets at the top with separate cards. Updated metrics description to reflect both available metrics library and creating custom metrics. Removed Feedback Intelligence card. Moved Components to the end.Navigation (
mkdocs.yml): Updated navigation structure to match current library organization. Removed outdated tutorials from Get Started navigation. Flattened Experiments section (Experimentation and Datasets as direct children). Removed Feedback Intelligence from navigation. Reorganized to reflect experiments-first paradigm.Testing
How to Test
References
Screenshots/Examples (if applicable)