Conversation
Summary of ChangesHello @henchaves, 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 introduces a completely new documentation system built with Starlight, significantly enhancing the project's ability to present information clearly and effectively. The changes involve migrating to a modern static site generator, establishing a robust structure for technical content, and providing in-depth guides for key features like Giskard Checks. This initiative aims to improve discoverability and comprehension for users exploring Giskard's capabilities. 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. Changelog
Activity
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. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new documentation site using Starlight, which is a great initiative. The overall structure is well-organized. However, I've identified several critical issues that need attention. The dependency versions in package.json appear to be for future, unreleased packages, which will prevent the project from building. Additionally, there are widespread markdown syntax errors, such as incorrect admonition formatting, that will break content rendering. I've also noted some smaller issues with CSS syntax, broken links, and opportunities for improving consistency. My detailed comments below provide specific suggestions to resolve these issues.
| "@astrojs/react": "^4.4.2", | ||
| "@astrojs/starlight": "^0.37.6", | ||
| "@astrojs/tailwind": "^6.0.2", | ||
| "astro": "^5.6.1", | ||
| "react": "^19.2.4", | ||
| "react-dom": "^19.2.4", | ||
| "sharp": "^0.34.2", | ||
| "starlight-auto-sidebar": "^0.1.4", | ||
| "tailwindcss": "^3.4.19" |
There was a problem hiding this comment.
The versions for several dependencies (astro, @astrojs/starlight, @astrojs/react, react, react-dom, tailwindcss) appear to point to future, unreleased versions. For instance, astro is listed as ^5.6.1, but the latest stable version is in the 4.x range. This will likely cause npm install to fail. Please update these dependencies to their correct, currently available versions.
| ) | ||
| ``` | ||
|
|
||
| SemanticSimilarity \~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~~ |
There was a problem hiding this comment.
This line appears to be a malformed heading. The tildes (~) will not be rendered as a heading. To fix this, it should be formatted as a level 2 Markdown heading.
| SemanticSimilarity \~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~~ | |
| ## SemanticSimilarity |
docs-new/astro.config.mjs
Outdated
| ], | ||
| social: [ | ||
| { label: 'GitHub', href: 'https://github.com/Giskard-AI/giskard', icon: 'github' }, | ||
| { label: 'Discord', href: 'https://discord.gg/fUfP5S3m', icon: 'discord' }, |
There was a problem hiding this comment.
The Discord invite link https://discord.gg/fUfP5S3m might be a temporary one that could expire. For long-term stability, it's better to use a permanent vanity URL if one is available (e.g., discord.gg/giskardai). Please consider updating this to a permanent link.
docs-new/src/components/Header.astro
Outdated
| <a href="https://docs.giskard.ai/" class="nav-link">Overview</a> | ||
| <a href="https://docs.giskard.ai/hub/ui" class="nav-link">Hub UI</a> | ||
| <a href="https://docs.giskard.ai/hub/sdk" class="nav-link">Hub SDK</a> |
There was a problem hiding this comment.
The navigation links for "Overview", "Hub UI", and "Hub SDK" use absolute URLs pointing to https://docs.giskard.ai. If the intention is to link to pages within this new Starlight site, it's better to use root-relative paths (e.g., /, /hub/ui/, /hub/sdk/). This ensures that the links work correctly in all environments, including local development. If these links are intentionally pointing to an existing, separate site, you can disregard this comment.
<a href="/" class="nav-link">Overview</a>
<a href="/hub/ui/" class="nav-link">Hub UI</a>
<a href="/hub/sdk/" class="nav-link">Hub SDK</a>
| - [Phare arXiv paper](https://arxiv.org/abs/2505.11365) | ||
| </Card> | ||
| <Card title="RealHarm" icon="document"> | ||
| RealHarm is a dataset of problematic interactions with textual AI agents built from a systematic review of publicly reported incidents. | ||
|
|
||
| - [RealHarm website](https://realharm.giskard.ai/) | ||
| - [RealHarm arXiv paper](https://arxiv.org/abs/2504.10277) |
There was a problem hiding this comment.
The arXiv links for Phare and RealHarm appear to have typos in their identifiers, pointing to papers from 2025 (e.g., 2505.11365). If these papers are from 2024, the identifiers should likely start with 24.... Please verify and correct these links.
| > [!NOTE] | ||
| > **Internal Implementation Detail**: `TestCase` is an internal | ||
| > implementation detail. Users should always use `scenario()` to create | ||
| > scenarios, which internally uses TestCase. The `scenario()` function | ||
| > creates a Scenario (a list of steps) and is the primary user-facing | ||
| > API. |
There was a problem hiding this comment.
This file uses GitHub-flavored markdown for notes (> [!NOTE]). For consistency and to leverage Starlight's styling, you should use Starlight's admonition syntax (:::note).
This pattern is also present in:
docs-new/src/content/docs/oss/checks/api-reference/scenarios.md(line 81)docs-new/src/content/docs/oss/checks/testing/core-concepts.md(line 140)
| > [!NOTE] | |
| > **Internal Implementation Detail**: `TestCase` is an internal | |
| > implementation detail. Users should always use `scenario()` to create | |
| > scenarios, which internally uses TestCase. The `scenario()` function | |
| > creates a Scenario (a list of steps) and is the primary user-facing | |
| > API. | |
| :::note | |
| **Internal Implementation Detail**: `TestCase` is an internal | |
| implementation detail. Users should always use `scenario()` to create | |
| scenarios, which internally uses TestCase. The `scenario()` function | |
| creates a Scenario (a list of steps) and is the primary user-facing | |
| API. | |
| ::: |
|
|
||
| ## Next Steps | ||
|
|
||
| Head to the [Quickstart](/oss/checks/ai-testing/quickstart) to write your first test! |
There was a problem hiding this comment.
This link to the Quickstart guide appears to be broken. The path contains ai-testing, but the directory is named testing. Please correct the path to ensure the link works.
| Head to the [Quickstart](/oss/checks/ai-testing/quickstart) to write your first test! | |
| Head to the [Quickstart](/oss/checks/testing/quickstart/) to write your first test! |
| - Apply custom checks in `../tutorials/index` | ||
| - Review `single-turn` and `multi-turn` for usage patterns | ||
| - See the `core-concepts` for architecture details |
There was a problem hiding this comment.
The links in the "Next Steps" section use relative paths (e.g., ../tutorials/index). While functional, using root-relative paths (e.g., /oss/checks/tutorials/) is more robust against future file restructuring. Consider standardizing on root-relative paths for all internal documentation links for better maintainability.
| - Apply custom checks in `../tutorials/index` | |
| - Review `single-turn` and `multi-turn` for usage patterns | |
| - See the `core-concepts` for architecture details | |
| - Apply custom checks in `../tutorials/` | |
| - Review `single-turn` and `multi-turn` for usage patterns | |
| - See the `core-concepts` for architecture details |
| h4, | ||
| h5, | ||
| h6 { | ||
| font-family: 'Osmose', system-ui, -apple-system, sans-serif !important; |
There was a problem hiding this comment.
Using !important to force the font family can make the CSS harder to maintain and debug. Starlight's customCss feature should load this file with enough specificity to override default styles. Please consider removing !important and verifying that the custom font is still applied correctly.
| font-family: 'Osmose', system-ui, -apple-system, sans-serif !important; | |
| font-family: 'Osmose', system-ui, -apple-system, sans-serif; |
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
giskard-docs | a4f489e | Mar 19 2026, 05:34 AM |
…`file` to `data` - Revised the parameter name from `file` to `data` in the migration, agents-and-knowledge-bases, and datasets-and-checks guides for consistency and clarity. - Updated examples to align with the new parameter naming convention.
Co-authored-by: Kevin Messiaen <114553769+kevinmessiaen@users.noreply.github.com>
Co-authored-by: Kevin Messiaen <114553769+kevinmessiaen@users.noreply.github.com>
- Added new tutorials for RAG evaluation, testing agents, chatbot testing, and content moderation to enhance practical examples. - Updated the API reference structure by removing the toctree and improving the overview section for better clarity. - Streamlined the documentation layout to improve navigation and user experience across tutorials and API references.
- Added a new function `cellOutputText` to extract and format cell output text from Jupyter notebooks, improving the conversion process. - Updated the `convertNotebook` function to handle frontmatter extraction more robustly by scanning for the first raw cell starting with "---". - Revised multiple documentation files to improve clarity, including renaming titles and labels for better consistency. - Enhanced examples and explanations across various sections to ensure better user understanding and navigation.
- Added generated notebook files to .gitignore to prevent accidental commits. - Updated the dev script in package.json to include a notebook conversion step before starting the development server. - Introduced a new Jupyter notebook for the quickstart guide, replacing the previous markdown file to enhance user experience and provide interactive content. - Removed outdated markdown files related to quickstart and batch evaluation to streamline documentation.
…spying - Enhanced the `simulate-users` notebook with updated execution metadata and improved user prompts for clarity. - Revised the `spy-on-calls` notebook to better explain the `WithSpy` functionality, including clearer scenarios and code examples. - Updated execution timestamps and outputs across multiple cells to reflect recent runs, ensuring accuracy in documentation. - Improved markdown sections for better readability and understanding of the user simulation and spying processes.
- Changed the `proseWrap` setting in `.prettierrc.json` from "always" to "preserve" for better formatting control. - Streamlined the welcome section in `index.mdx` by consolidating bullet points into single lines for improved readability. - Removed outdated `concepts.md`, `index.mdx`, `migration.md`, `quickstart.md`, `reference.md`, `release-notes.md`, and several guides to declutter the documentation and focus on essential content. - Enhanced the overall structure and clarity of the documentation to facilitate easier navigation and understanding for users.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
chore(checks): starlight docs david
- Updated the index, migration, quickstart, and reference guides to reflect changes in parameter names and structures. - Added detailed examples for API key retrieval and improved descriptions for evaluation and scan metrics. - Clarified the request and response formats for agent interactions and enhanced the metadata handling in test cases. - Revised the guides to ensure consistent terminology and improved usability across the documentation.
…guide - Introduced new components: MethodCard, Property, ResourceSection, and TypeTable for better organization and presentation of API documentation. - Replaced the old reference markdown file with a new MDX file that utilizes the new components for improved clarity and interactivity. - Enhanced the API reference to include detailed descriptions, parameters, and examples for various resources and methods in the Giskard Hub Python SDK.
…mmand Cloudflare Pages dashboard may default to `astro build` (Astro preset), which skips the notebook-to-markdown conversion step. This config ensures `npm run build` is used, which runs convert-notebooks.mjs before astro build. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ved readability - Removed the 'name' prop from ResourceSection, streamlining its usage in the documentation. - Updated TypeTable to use a button for toggling visibility, enhancing accessibility and user interaction. - Adjusted styles for better alignment and consistency across components.
- Added a comprehensive feature mapping table detailing renamed APIs, parameters, and patterns between v2.x and v3.x. - Included a section on new features in v3.x that have no v2.x equivalent, highlighting additive resources. - Updated breaking changes section to reflect environment variable renaming and other significant modifications for migration.
…e, project, scenario, and scan methods - Refined method descriptions for CRUD operations across various resources, including clearer parameter definitions. - Separated combined method cards into individual entries for better clarity and usability. - Enhanced documentation to provide detailed information on required properties for each method.
- Updated the release notes to reflect the official v3.0.0 release, transitioning from the beta version. - Introduced new features including `AsyncHubClient`, enhanced Playground Chats, and improved Audit Logs. - Clarified the support for CRUD operations across most resources. - Removed the known limitations section that was relevant to the beta phase.
- Changed the title from "Audit Log" to "Audit Logs" to align with terminology used throughout the documentation.
- Changed the title from "API Reference" to "Reference" to enhance consistency and clarity in the documentation.
- Removed execution counts and metadata from code cells to streamline the notebook format. - Enhanced the introduction to clarify the purpose of scenarios and suites. - Expanded the tutorial to include four distinct scenarios for a customer-support chatbot, improving the instructional content. - Updated code examples for better readability and functionality, ensuring a more cohesive learning experience.
Align the API docs with the real `Scenario` fluent interface: there is no `.build()` method. Made-with: Cursor
3 participants
No description provided.