docs: update README and repo docs for v3#2335
Conversation
Align repo documentation with the v3 announcement and roadmap: - README: simplify quickstart to single LLM example, add component status table (checks, scan, rag), switch callout to NOTE tone, link to announcement and roadmap - CONTRIBUTING: update for checks API, ruff tooling, remove docker refs - Bug template: add v3/v2 version dropdown, pip/uv install sources Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on updating the project's documentation and issue templates to align with the new Giskard v3 architecture. The changes aim to provide clearer guidance for users and contributors, reflecting the shift towards AI agents and LLM systems, and streamlining the development process with updated tooling and versioning information. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request updates the project's documentation across the bug report template, contributing guidelines, and README to reflect the ongoing transition to Giskard v3. The changes include updating versioning, installation instructions, and contribution areas, emphasizing AI agent checks over traditional ML tests. The README is significantly revised to introduce the modular Giskard v3 architecture, provide a quickstart for giskard-checks, and clarify the status and usage of Giskard v2 features (Scan and RAGET). Feedback from the review highlights an undefined variable in the v2 Scan example within README.md and suggests explicitly mentioning the openai dependency in the giskard-checks quickstart for better clarity.
Address PR review comment about undefined my_llm_chain variable. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Vary terminology naturally instead of repeating the full list everywhere. Also remove Giskard v2 option from bug template dropdown. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
|
@kevinmessiaen I prepared this for the release. For now, I thought it would be good to mention our goals to move Also, I've updated some phrasing related to agents, agentic systems, and LLMs, while explicitly stating that ML is no longer part of the deal. |
Summary
giskard-checks,giskard-scan,giskard-ragwith links to v2 predecessors), switched callout from WARNING to NOTE, aligned messaging with v3 announcement and roadmapTest plan
🤖 Generated with Claude Code