Skip to content

fix(docs): correct typos and improve formatting in README.md#2448

Merged
davidberenstein1957 merged 2 commits into
mainfrom
chore/update-readme
May 13, 2026
Merged

fix(docs): correct typos and improve formatting in README.md#2448
davidberenstein1957 merged 2 commits into
mainfrom
chore/update-readme

Conversation

@henchaves
Copy link
Copy Markdown
Member

Description

This PR updates the README.md file, fixing typos and improving formatting.

Type of Change

  • 📚 Examples / docs / tutorials / dependencies update
  • 🔧 Bug fix (non-breaking change which fixes an issue)
  • 🥂 Improvement (non-breaking change which improves an existing feature)
  • 🚀 New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 🔐 Security fix

@henchaves henchaves self-assigned this May 12, 2026
@henchaves henchaves requested a review from kevinmessiaen May 12, 2026 14:16
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 README by fixing typos, improving formatting, and promoting giskard-checks to Beta status. It also simplifies a code example by removing a parameter and deletes the "Current sponsors" section. Feedback indicates that the removal of the sponsors section may be accidental or out of scope for this PR, and a suggestion was made to reduce excessive padding in the Markdown table to improve source code readability.

I am having trouble creating individual review comments. Click here to see my feedback.

README.md (177-187)

high

The "Current sponsors" section has been entirely removed in this PR. Since the PR's stated goal is to "correct typos and improve formatting," this significant content change seems out of scope and might be accidental. If these companies are still sponsoring the project, please restore this section.

README.md (44-48)

medium

The table formatting in this section uses excessive padding for the Description column, which makes the raw Markdown file difficult to read and maintain. While some formatters do this automatically, it's generally better to keep the padding to a minimum (e.g., one space) to improve source code readability.

| Status         | Package          | Description |
| -------------- | ---------------- | ----------- |
| ✅ Beta        | `giskard-checks` | Testing & evaluation — scenario API, built-in checks, LLM-as-judge |
| 🚧 In progress | `giskard-scan`   | Agent vulnerability scanner — red teaming, prompt injection, data leakage (successor of [v2 Scan](https://legacy-docs.giskard.ai/en/stable/open_source/scan/index.html)) |
| 📋 Planned     | `giskard-rag`    | RAG evaluation & synthetic data generation (successor of [v2 RAGET](https://legacy-docs.giskard.ai/en/stable/open_source/testset_generation/index.html)) |

@davidberenstein1957 davidberenstein1957 merged commit 533e69d into main May 13, 2026
38 of 39 checks passed
@davidberenstein1957 davidberenstein1957 deleted the chore/update-readme branch May 13, 2026 09:11
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.

2 participants