Skip to content

docs: update README and repo docs for v3#2335

Merged
kevinmessiaen merged 7 commits intomainfrom
davidberenstein1957/update-readme-v3
Mar 26, 2026
Merged

docs: update README and repo docs for v3#2335
kevinmessiaen merged 7 commits intomainfrom
davidberenstein1957/update-readme-v3

Conversation

@davidberenstein1957
Copy link
Copy Markdown
Member

Summary

  • README: Simplified quickstart to single "Test your own LLM" example, added v3 component status table (giskard-checks, giskard-scan, giskard-rag with links to v2 predecessors), switched callout from WARNING to NOTE, aligned messaging with v3 announcement and roadmap
  • CONTRIBUTING: Updated for checks API terminology, ruff tooling, removed docker references
  • Bug template: Added v3/v2 version dropdown, updated install sources to pip/uv

Test plan

  • Verify README renders correctly on GitHub (table, NOTE callout, code block)
  • Verify all external links resolve (announcement, roadmap, v2 docs)
  • Verify bug template renders correctly in issue creation flow

🤖 Generated with Claude Code

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>
@davidberenstein1957 davidberenstein1957 requested a review from a team as a code owner March 25, 2026 14:59
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, 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

  • README Update: The README was significantly updated to simplify the quickstart guide, introduce a v3 component status table, change a callout from WARNING to NOTE, and align messaging with the v3 announcement and roadmap.
  • CONTRIBUTING Guide Modernization: The CONTRIBUTING guide was updated to reflect new checks API terminology, switch to ruff tooling for formatting and linting, and remove outdated Docker references.
  • Bug Template Enhancement: The bug report template was improved by adding a Giskard v3/v2 version dropdown and updating installation source options to include pip and uv, while removing docker.

🧠 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 Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

davidberenstein1957 and others added 2 commits March 25, 2026 16:20
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>
@davidberenstein1957
Copy link
Copy Markdown
Member Author

@kevinmessiaen I prepared this for the release. For now, I thought it would be good to mention our goals to move giskard-scan and giskard-rag(et) to v3 as well, while still referencing the legacy methods in the readme overview.

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.

@kevinmessiaen kevinmessiaen merged commit f47879e into main Mar 26, 2026
23 checks passed
@kevinmessiaen kevinmessiaen deleted the davidberenstein1957/update-readme-v3 branch March 26, 2026 01:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants