fix: [ENG-805]/[GSK-4620] design and content update of new docs #75
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lansolo99
changed the title
* Update documentation structure and enhance content for clarity - Increased the max depth of the table of contents in index.rst for better navigation. - Replaced the glossary entry with a new index file to improve organization and accessibility of terms. - Added detailed sections on various business vulnerabilities, including addition of information, business out of scope, denial of answers, and hallucination, with examples and metrics for detection. - Introduced new benchmarks for LLMs, covering coding, conversation quality, and domain-specific evaluations, enhancing the comprehensiveness of the documentation. - Improved formatting and consistency across multiple documentation files to streamline user experience. * Update dependencies in pyproject.toml and enhance documentation structure - Updated dependency versions for several packages in pyproject.toml to ensure compatibility and stability. - Added new dependencies for Sphinx extensions and improved documentation clarity by including additional extensions in the configuration. - Enhanced the index.rst file by organizing notebooks into distinct categories for better navigation. - Updated copyright year dynamically in conf.py to reflect the current year. * Remove outdated Furo dependency from pyproject.toml to streamline project requirements. * Update feature comparison documentation for consistency and clarity - Standardized terminology for detection capabilities, changing "state-of-the-art detection" to "State-of-the-art detection" for both security vulnerabilities and business failures. - Enhanced formatting for improved readability and consistency across the feature comparison section. * Update documentation and dependencies for clarity and functionality - Updated the Poetry lock file to reflect the new version of dependencies and removed unnecessary groups from several packages. - Enhanced documentation by adding new sections on evaluations, including creation, retrieval, updating, and deletion of evaluations and scheduled evaluations. - Improved clarity in the SDK documentation by refining descriptions and examples, particularly in the business and security testing sections. - Standardized terminology and formatting across various documentation files for consistency and better user experience. * Refactor terminology in business documentation for consistency - Changed instances of "Business Vulnerabilities" to "Business Failures" throughout the index.rst file to standardize terminology. - Updated related sections to reflect the new terminology, enhancing clarity and consistency in the documentation. * drop documentation of unreleased features --------- Co-authored-by: Henrique Chaves <[email protected]>
… for dependency version changes and group assignments
henchaves
requested review from
henchaves
and removed request for
davidberenstein1957
henchaves
approved these changes
Aug 28, 2025
henchaves
changed the title
…yproject.toml to 2.18.0, and adjust content-hash in poetry.lock for dependency management.
…ty and improvements - Updated `myst-parser` to version 3.0.1 and `nbsphinx` to version 0.9.7. - Adjusted versions for `sphinx-click`, `sphinx-autobuild`, `sphinx-design`, and `sphinx-tabs` for better compatibility. - Added conditional dependencies for `torch` based on the platform. - Removed outdated package entries from `poetry.lock` to streamline dependency management.
- Updated Open Graph configuration in `conf.py` to include a new image and site URL. - Removed outdated Open Graph image and added a new PNG version. - Revised glossary entries to standardize terminology, changing "Business Failures" to "AI Business Failures" and "Security Vulnerabilities" to "AI Security Vulnerabilities". - Enhanced descriptions in glossary sections for better understanding of AI-related concepts.
…Open Graph settings in documentation - Updated Python version in `.github/workflows/update-docs.yml` to 3.12 for compatibility with Giskard 2.18.0. - Revised Open Graph settings in `conf.py`, including changes to image format and added dimensions for better social media integration. - Standardized glossary entries to improve clarity and consistency in terminology related to AI business failures and security vulnerabilities.
… integration - Updated Open Graph image URL in `conf.py` to dynamically reference the canonical URL. - Removed outdated Open Graph image type and Twitter Card support for a cleaner configuration. - Ensured consistency in Open Graph image properties for better compatibility across platforms.
…t support - Added fallback URL for Open Graph site URL in `conf.py` to ensure local builds function correctly. - Updated Open Graph image path to use a relative reference for improved compatibility during local development. - Removed redundant Open Graph image URL construction for a cleaner configuration.
… and consistency - Changed Open Graph site URL to a new canonical link for better accessibility. - Removed unnecessary Open Graph properties to streamline the configuration. - Enhanced overall readability of the Open Graph settings in `conf.py`.
… for clarity - Implemented a fixed enterprise trial banner with responsive styles in `custom.css` and `custom.js`. - Added JavaScript logic to manage the banner's visibility and theme updates. - Created a new base HTML template to inject the banner dynamically. - Standardized glossary section titles for better clarity, changing headings to include "in AI" for various terms. - Enhanced descriptions in glossary entries to improve understanding of AI-related concepts.
- Removed local storage check for banner visibility to ensure it displays consistently. - Enhanced close button functionality with smooth animation and conditional removal of the banner. - Cleaned up the code by eliminating the resetBannerState function, streamlining banner management.
- Added a canonical Open Graph site URL for improved accessibility. - Updated Open Graph image URL to a direct link for better social media integration. - Ensured consistency in Open Graph configuration for clearer documentation.
- Added promotional tips for Giskard Hub and enterprise trial across various documentation sections to encourage user engagement. - Updated glossary section titles for consistency and clarity, changing headings to improve understanding of AI-related concepts. - Enhanced descriptions in glossary entries to provide clearer insights into AI business failures and security vulnerabilities. - Removed outdated footer extension code to streamline documentation structure.
- Simplified the title of the comparison section from "Open Source vs Giskard Hub" to "Open Source vs Hub" for brevity. - Revised promotional tip wording to enhance user appeal, changing "Ready to try Giskard Hub?" to "Convinced by our features?". - Removed an unnecessary blank line in the security glossary section to improve formatting.
- Revised the description of enterprise-grade support by removing the mention of SLAs for improved accuracy. - Enhanced overall clarity in the feature comparison section to better reflect the offerings.
- Changed the background color of the enterprise trial banner in dark mode from a semi-transparent white to solid white for better visibility. - Added session storage logic to prevent the banner from reappearing if it was closed during the current tab session, enhancing user experience.
|
davidberenstein1957
deleted the
fix/gsk-4620-new-merged-giskard-documentation-design-update
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.