docs: quickstart guide with interactive LLM and project structure #2380
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
…export utility, and fix venv issues
dosubot
bot
added
size:XL
Contributor
|
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) 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
added a commit
that referenced
this pull request
Nov 17, 2025
) ## 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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Changes Made
Documentation (docs/getstarted/evals.md):
quickstartcmd to follow through guide with an example project.generated code
llm_factoryAPIsyntax
Build Configuration (mkdocs.yml):
enabled: !ENV [MKDOCS_CI, true]Makefile:
MKDOCS_CI=falseto serve-docs target. This avoids social plugin error in macos if in casecairosvgis not found.