docs(checks): simplify API surface in tutorials with fluent API focus - #2230
Merged
kevinmessiaen merged 1 commit intoJan 20, 2026
Conversation
Refactor documentation to prioritize the fluent API pattern scenario().interact().check() over InteractionSpec and TestCase APIs. Changes: - Update all tutorial files (rag-evaluation, testing-agents, chatbot-testing) to use fluent API instead of InteractionSpec/TestCase - Update getting started guides (quickstart, single-turn, multi-turn) to prioritize fluent API - De-emphasize InteractionSpec/TestCase in core-concepts, move to Advanced Usage - Update giskard-checks README to use fluent API in Quickstart section - Move InteractionSpec/TestCase examples to Advanced Usage section in README - Update Python docstrings (TestCase, Scenario, InteractionSpec) to recommend fluent API for most use cases - Wrap all examples in async functions with asyncio.run() for proper execution - Rename test_* functions to run_*_example() to avoid pytest confusion This reduces the learning curve for beginners while keeping advanced APIs available in reference documentation for power users. Refs: ENG-1294
kevinmessiaen
deleted the
feature/eng-1294-docs-simplify-api-surface-in-tutorials-fluent-api-focus
branch
January 20, 2026 09:05
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Refactor documentation to prioritize the fluent API pattern scenario().interact().check() over InteractionSpec and TestCase APIs.
Changes:
This reduces the learning curve for beginners while keeping advanced APIs available in reference documentation for power users.
Refs: ENG-1294