Skip to content

docs: quickstart guide with interactive LLM and project structure #2380

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 11 commits into from
Oct 30, 2025
Merged

docs: quickstart guide with interactive LLM and project structure #2380

merged 11 commits into from
Oct 30, 2025

Conversation

@anistark
Copy link
Member

@anistark anistark commented Oct 23, 2025 •
edited
Loading

Changes Made

Documentation (docs/getstarted/evals.md):

  • Added quickstart cmd to follow through guide with an example project.
  • Updated "Custom Evaluation with LLMs" to reference DiscreteMetric from
    generated code
  • Replaced static examples with modern llm_factory API
  • Changed "Using Pre-Built Metrics" to AspectCritic with modern async/await
    syntax
  • Updated "Evaluating on a Dataset" to use ragas.Dataset API

Build Configuration (mkdocs.yml):

  • Made social plugin conditional: enabled: !ENV [MKDOCS_CI, true]

Makefile:

  • Added explicit MKDOCS_CI=false to serve-docs target. This avoids social plugin error in macos if in case cairosvg is not found.

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Oct 23, 2025
@anistark anistark marked this pull request as draft October 26, 2025 08:31
@anistark anistark marked this pull request as ready for review October 29, 2025 20:08
@dosubot dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Oct 29, 2025
@sanjeed5
Copy link
Contributor

sanjeed5 commented Oct 30, 2025

Thoughts on quickstart:

experiments_quickstart this feels a lot more simpler and easier to understand than proposed quickstart according to me. (and Claude and GPT)
Tutorials - learn by doing according to diataxis too.

Also regarding the other rag_eval guide, we already have an experiment first rag evals guide, so we can remove the older metrics based ones. This is done in #2394

Other stuff looks great! That makefile fix is great!

@anistark anistark merged commit b2d7693 into explodinggradients:main Oct 30, 2025
14 of 15 checks passed
@anistark anistark deleted the docs/refactor-examples branch October 30, 2025 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

size:XL This PR changes 500-999 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@anistark @sanjeed5