Conversation
- Set trailingSlash to 'never' in Astro config for consistent URL handling. - Introduced new llms.txt file containing comprehensive documentation for Giskard products and LLMs. - Added robots.txt to manage web crawler access and specify sitemap location. - Implemented middleware for handling trailing slashes in URLs. - Created Head.astro component for structured data and breadcrumb navigation. - Updated Header and Sidebar components to remove trailing slashes from links. - Added dynamic markdown endpoint for documentation pages.
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 significantly enhances the documentation site's discoverability and accessibility for both traditional search engines and modern generative AI models. By standardizing URL structures, embedding rich structured data, and providing dedicated content feeds for LLMs, the changes aim to improve how the documentation is indexed, presented in search results, and consumed by AI agents. This strategic update ensures that the Giskard documentation is optimized for a broader range of information retrieval and AI-driven applications. 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
|
![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
The pull request introduces a new trailingSlash: 'never' configuration to astro.config.mjs and a new middleware.ts file to enforce canonical URLs by redirecting paths with trailing slashes. Additionally, it adds lastUpdated: true and a custom Head.astro component to astro.config.mjs for improved SEO and metadata generation, including JSON-LD for organization, breadcrumbs, and articles. A new llms.txt file is added, containing a comprehensive markdown overview of Giskard documentation. The PR also updates numerous internal links across various documentation files (MDX and IPYNB) by removing trailing slashes to ensure URL consistency, aligning with the new canonical URL policy.
| "- [Run in pytest](/oss/checks/how-to/run-in-pytest) — integrate batch tests\n", | ||
| " into CI with proper failure reporting\n", | ||
| "- [Test Suites](/oss/checks/tutorials/test-suites/) — group named scenarios\n", | ||
| "- [Test Suites](/oss/checks/tutorials/test-suites) — group named scenarios\n", | ||
| " rather than iterate over a data list\n", | ||
| "- [Structured Output Testing](/oss/checks/how-to/structured-output/) — validate\n", | ||
| "- [Structured Output Testing](/oss/checks/how-to/structured-output) — validate\n", | ||
| " Pydantic models or dicts" |
There was a problem hiding this comment.
Removing trailing slashes from internal links in the 'Next steps' section ensures URL consistency across the documentation. This aligns with the site's canonical URL policy.
| "- [Run in pytest](/oss/checks/how-to/run-in-pytest) — integrate batch tests\n", | |
| " into CI with proper failure reporting\n", | |
| "- [Test Suites](/oss/checks/tutorials/test-suites/) — group named scenarios\n", | |
| "- [Test Suites](/oss/checks/tutorials/test-suites) — group named scenarios\n", | |
| " rather than iterate over a data list\n", | |
| "- [Structured Output Testing](/oss/checks/how-to/structured-output/) — validate\n", | |
| "- [Structured Output Testing](/oss/checks/how-to/structured-output) — validate\n", | |
| " Pydantic models or dicts" | |
| "- [Run in pytest](/oss/checks/how-to/run-in-pytest) — integrate batch tests\n", | |
| " into CI with proper failure reporting\n", | |
| "- [Test Suites](/oss/checks/tutorials/test-suites) — group named scenarios\n", | |
| " rather than iterate over a data list\n", | |
| "- [Structured Output Testing](/oss/checks/how-to/structured-output) — validate\n" |
| "\n", | ||
| "- Tests are already running locally with pytest (see\n", | ||
| " [Run Tests with pytest](/oss/checks/how-to/run-in-pytest/))\n", | ||
| " [Run Tests with pytest](/oss/checks/how-to/run-in-pytest))\n", |
There was a problem hiding this comment.
The removal of the trailing slash from [Run Tests with pytest](/oss/checks/how-to/run-in-pytest/) to [Run Tests with pytest](/oss/checks/how-to/run-in-pytest) improves URL consistency.
| " [Run Tests with pytest](/oss/checks/how-to/run-in-pytest))\n", | |
| " [Run Tests with pytest](/oss/checks/how-to/run-in-pytest))\n" |
| "- [Run Tests with pytest](/oss/checks/how-to/run-in-pytest) — full pytest setup\n", | ||
| " including parametrize and fixtures\n", | ||
| "- [Batch Evaluation](/oss/checks/how-to/batch-evaluation/) — evaluate many\n", | ||
| "- [Batch Evaluation](/oss/checks/how-to/batch-evaluation) — evaluate many\n", | ||
| " scenarios efficiently in a single run" |
There was a problem hiding this comment.
Removing trailing slashes from internal links in the 'Next steps' section ensures URL consistency across the documentation. This aligns with the site's canonical URL policy.
| "- [Run Tests with pytest](/oss/checks/how-to/run-in-pytest) — full pytest setup\n", | |
| " including parametrize and fixtures\n", | |
| "- [Batch Evaluation](/oss/checks/how-to/batch-evaluation/) — evaluate many\n", | |
| "- [Batch Evaluation](/oss/checks/how-to/batch-evaluation) — evaluate many\n", | |
| " scenarios efficiently in a single run" | |
| "- [Run Tests with pytest](/oss/checks/how-to/run-in-pytest) — full pytest setup\n", | |
| " including parametrize and fixtures\n", | |
| "- [Batch Evaluation](/oss/checks/how-to/batch-evaluation) — evaluate many\n" |
| "- [API Reference: Checks](/oss/checks/reference/checks) — full list of built-in\n", | ||
| " checks and their parameters\n", | ||
| "- [Single-Turn Evaluation](/oss/checks/tutorials/single-turn/) — using checks in\n", | ||
| "- [Single-Turn Evaluation](/oss/checks/tutorials/single-turn) — using checks in\n", | ||
| " a scenario\n", | ||
| "- [Stateful Checks](/oss/checks/how-to/stateful-checks/) — checks that\n", | ||
| "- [Stateful Checks](/oss/checks/how-to/stateful-checks) — checks that\n", |
There was a problem hiding this comment.
Removing trailing slashes from internal links in the 'Next steps' section ensures URL consistency across the documentation. This aligns with the site's canonical URL policy.
| "- [API Reference: Checks](/oss/checks/reference/checks) — full list of built-in\n", | |
| " checks and their parameters\n", | |
| "- [Single-Turn Evaluation](/oss/checks/tutorials/single-turn/) — using checks in\n", | |
| "- [Single-Turn Evaluation](/oss/checks/tutorials/single-turn) — using checks in\n", | |
| " a scenario\n", | |
| "- [Stateful Checks](/oss/checks/how-to/stateful-checks/) — checks that\n", | |
| "- [Stateful Checks](/oss/checks/how-to/stateful-checks) — checks that\n", | |
| "- [API Reference: Checks](/oss/checks/reference/checks) — full list of built-in\n", | |
| " checks and their parameters\n", | |
| "- [Single-Turn Evaluation](/oss/checks/tutorials/single-turn) — using checks in\n", | |
| " a scenario\n", | |
| "- [Stateful Checks](/oss/checks/how-to/stateful-checks) — checks that\n" |
| "- [Async design & pytest](/oss/checks/explanation/async-and-pytest) — why\n", | ||
| " `Scenario.run()` is async\n", | ||
| "- [Single-turn testing tutorial](/oss/checks/tutorials/single-turn/) — the\n", | ||
| "- [Single-turn testing tutorial](/oss/checks/tutorials/single-turn) — the\n", | ||
| " scenario patterns used above\n", | ||
| "- [Simulate Users](/oss/checks/how-to/simulate-users/) — drive multi-turn tests\n", | ||
| "- [Simulate Users](/oss/checks/how-to/simulate-users) — drive multi-turn tests\n", |
There was a problem hiding this comment.
Removing trailing slashes from internal links in the 'Next steps' section ensures URL consistency across the documentation. This aligns with the site's canonical URL policy.
| "- [Async design & pytest](/oss/checks/explanation/async-and-pytest) — why\n", | |
| " `Scenario.run()` is async\n", | |
| "- [Single-turn testing tutorial](/oss/checks/tutorials/single-turn/) — the\n", | |
| "- [Single-turn testing tutorial](/oss/checks/tutorials/single-turn) — the\n", | |
| " scenario patterns used above\n", | |
| "- [Simulate Users](/oss/checks/how-to/simulate-users/) — drive multi-turn tests\n", | |
| "- [Simulate Users](/oss/checks/how-to/simulate-users) — drive multi-turn tests\n", | |
| "- [Async design & pytest](/oss/checks/explanation/async-and-pytest) — why\n", | |
| " `Scenario.run()` is async\n", | |
| "- [Single-turn testing tutorial](/oss/checks/tutorials/single-turn) — the\n", | |
| " scenario patterns used above\n", | |
| "- [Simulate Users](/oss/checks/how-to/simulate-users) — drive multi-turn tests\n" |
| "tutorial shows you how to configure a generator and test an actual LLM call:\n", | ||
| "\n", | ||
| "[Your First LLM Call](/oss/checks/tutorials/single-turn/)" | ||
| "[Your First LLM Call](/oss/checks/tutorials/single-turn)" |
There was a problem hiding this comment.
The removal of the trailing slash from [Your First LLM Call](/oss/checks/tutorials/single-turn/) to [Your First LLM Call](/oss/checks/tutorials/single-turn) improves URL consistency.
"[Your First LLM Call](/oss/checks/tutorials/single-turn)"\n
| "- See [Content Moderation](/oss/checks/use-cases/content-moderation) for safety\n", | ||
| " and filtering\n", | ||
| "- Explore [Testing Agents](/oss/checks/use-cases/testing-agents/) for tool-using\n", | ||
| "- Explore [Testing Agents](/oss/checks/use-cases/testing-agents) for tool-using\n", | ||
| " chatbots\n", | ||
| "- Review [Multi-Turn Scenarios](/oss/checks/tutorials/multi-turn/) for complex\n", | ||
| "- Review [Multi-Turn Scenarios](/oss/checks/tutorials/multi-turn) for complex\n", | ||
| " flows" |
There was a problem hiding this comment.
Removing trailing slashes from internal links in the 'Next Steps' section ensures URL consistency across the documentation. This aligns with the site's canonical URL policy.
| "- See [Content Moderation](/oss/checks/use-cases/content-moderation) for safety\n", | |
| " and filtering\n", | |
| "- Explore [Testing Agents](/oss/checks/use-cases/testing-agents/) for tool-using\n", | |
| "- Explore [Testing Agents](/oss/checks/use-cases/testing-agents) for tool-using\n", | |
| " chatbots\n", | |
| "- Review [Multi-Turn Scenarios](/oss/checks/tutorials/multi-turn/) for complex\n", | |
| "- Review [Multi-Turn Scenarios](/oss/checks/tutorials/multi-turn) for complex\n", | |
| " flows" | |
| "- See [Content Moderation](/oss/checks/use-cases/content-moderation) for safety\n", | |
| " and filtering\n", | |
| "- Explore [Testing Agents](/oss/checks/use-cases/testing-agents) for tool-using\n", | |
| " chatbots\n", | |
| "- Review [Multi-Turn Scenarios](/oss/checks/tutorials/multi-turn) for complex\n" |
| "- See [Custom Checks](/oss/checks/how-to/custom-checks) for building custom\n", | ||
| " safety checks\n", | ||
| "- Review [Single-Turn Evaluation](/oss/checks/tutorials/single-turn/) for more\n", | ||
| "- Review [Single-Turn Evaluation](/oss/checks/tutorials/single-turn) for more\n", | ||
| " guardrail patterns\n", | ||
| "- Explore [Chatbot Testing](/oss/checks/use-cases/chatbot-testing/) for\n", | ||
| "- Explore [Chatbot Testing](/oss/checks/use-cases/chatbot-testing) for\n", | ||
| " conversational safety testing" |
There was a problem hiding this comment.
Removing trailing slashes from internal links in the 'Next Steps' section ensures URL consistency across the documentation. This aligns with the site's canonical URL policy.
| "- See [Custom Checks](/oss/checks/how-to/custom-checks) for building custom\n", | |
| " safety checks\n", | |
| "- Review [Single-Turn Evaluation](/oss/checks/tutorials/single-turn/) for more\n", | |
| "- Review [Single-Turn Evaluation](/oss/checks/tutorials/single-turn) for more\n", | |
| " guardrail patterns\n", | |
| "- Explore [Chatbot Testing](/oss/checks/use-cases/chatbot-testing/) for\n", | |
| "- Explore [Chatbot Testing](/oss/checks/use-cases/chatbot-testing) for\n", | |
| " conversational safety testing" | |
| "- See [Custom Checks](/oss/checks/how-to/custom-checks) for building custom\n", | |
| " safety checks\n", | |
| "- Review [Single-Turn Evaluation](/oss/checks/tutorials/single-turn) for more\n", | |
| " guardrail patterns\n", | |
| "- Explore [Chatbot Testing](/oss/checks/use-cases/chatbot-testing) for\n" |
| "- See [Testing Agents](/oss/checks/use-cases/testing-agents) for agent-specific\n", | ||
| " testing patterns\n", | ||
| "- Explore [Chatbot Testing](/oss/checks/use-cases/chatbot-testing/) for\n", | ||
| "- Explore [Chatbot Testing](/oss/checks/use-cases/chatbot-testing) for\n", | ||
| " conversational testing\n", | ||
| "- Review [Multi-Turn Scenarios](/oss/checks/tutorials/multi-turn/) for advanced\n", | ||
| "- Review [Multi-Turn Scenarios](/oss/checks/tutorials/multi-turn) for advanced\n", | ||
| " scenarios" |
There was a problem hiding this comment.
Removing trailing slashes from internal links in the 'Next Steps' section ensures URL consistency across the documentation. This aligns with the site's canonical URL policy.
| "- See [Testing Agents](/oss/checks/use-cases/testing-agents) for agent-specific\n", | |
| " testing patterns\n", | |
| "- Explore [Chatbot Testing](/oss/checks/use-cases/chatbot-testing/) for\n", | |
| "- Explore [Chatbot Testing](/oss/checks/use-cases/chatbot-testing) for\n", | |
| " conversational testing\n", | |
| "- Review [Multi-Turn Scenarios](/oss/checks/tutorials/multi-turn/) for advanced\n", | |
| "- Review [Multi-Turn Scenarios](/oss/checks/tutorials/multi-turn) for advanced\n", | |
| " scenarios" | |
| "- See [Testing Agents](/oss/checks/use-cases/testing-agents) for agent-specific\n", | |
| " testing patterns\n", | |
| "- Explore [Chatbot Testing](/oss/checks/use-cases/chatbot-testing) for\n", | |
| " conversational testing\n", | |
| "- Review [Multi-Turn Scenarios](/oss/checks/tutorials/multi-turn) for advanced\n" |
| "- See [Chatbot Testing](/oss/checks/use-cases/chatbot-testing) for\n", | ||
| " conversational agent patterns\n", | ||
| "- Explore [RAG Evaluation](/oss/checks/use-cases/rag-evaluation/) for\n", | ||
| "- Explore [RAG Evaluation](/oss/checks/use-cases/rag-evaluation) for\n", | ||
| " knowledge-grounded agents\n", | ||
| "- Review [Multi-Turn Scenarios](/oss/checks/tutorials/multi-turn/) for complex\n", | ||
| "- Review [Multi-Turn Scenarios](/oss/checks/tutorials/multi-turn) for complex\n", | ||
| " workflows" |
There was a problem hiding this comment.
Removing trailing slashes from internal links in the 'Next Steps' section ensures URL consistency across the documentation. This aligns with the site's canonical URL policy.
| "- See [Chatbot Testing](/oss/checks/use-cases/chatbot-testing) for\n", | |
| " conversational agent patterns\n", | |
| "- Explore [RAG Evaluation](/oss/checks/use-cases/rag-evaluation/) for\n", | |
| "- Explore [RAG Evaluation](/oss/checks/use-cases/rag-evaluation) for\n", | |
| " knowledge-grounded agents\n", | |
| "- Review [Multi-Turn Scenarios](/oss/checks/tutorials/multi-turn/) for complex\n", | |
| "- Review [Multi-Turn Scenarios](/oss/checks/tutorials/multi-turn) for complex\n", | |
| " workflows" | |
| "- See [Chatbot Testing](/oss/checks/use-cases/chatbot-testing) for\n", | |
| " conversational agent patterns\n", | |
| "- Explore [RAG Evaluation](/oss/checks/use-cases/rag-evaluation) for\n", | |
| " knowledge-grounded agents\n", | |
| "- Review [Multi-Turn Scenarios](/oss/checks/tutorials/multi-turn) for complex\n" |
1 participant
Uh oh!
There was an error while loading. Please reload this page.