Skip to content

Conversation

@nrichers
Copy link
Collaborator

Pull Request Description

What and why?

This PR adds a simplified product tour to our docs site, covering where to find what.

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@nrichers nrichers added DO NOT MERGE PR is not ready to be merged internal Not to be externalized in the release notes labels Dec 31, 2025
@github-actions
Copy link
Contributor

PR Summary

This pull request introduces several functional enhancements to the training content and user interface. The primary changes include:

  1. In the AI governance course page, the call-to-action button text and link have been updated. The original 'register' button is replaced with a more descriptive 'Start the course →' link. Additionally, the include for the training registration component is now commented out, potentially to adjust the presentation of the page or to handle a conditional rendering scenario.

  2. A new SCSS styles file (use-cases.scss) has been added which contains robust styling details for various UI components. The stylesheet defines classes for buttons, animations (such as pulse effects), layout adjustments, image formatting, and other visual elements. This enhancement aims to provide a consistent and modern look throughout the training material pages.

  3. Updates in the training listing file adjust the content structure by adding a new course item for the 'What is ValidMind?' tour. The listing now includes an entry for a new product tour content, and section headers have been renamed (e.g., 'Using the product' to 'By user role' and 'Use cases' to 'By use case').

  4. A new file (what-is-validmind-register.qmd) has been introduced along with updates to the existing 'What is ValidMind?' content. This new interactive product tour guides users through a detailed walkthrough of various features such as the inventory, workflows, analytics, documentation, testing, and more. The content is structured with multiple slides and sections, offering a guided experience complete with animations, images, and interactive buttons.

Overall, these changes enhance the user navigation and provide richer, interactive content for training and product awareness without affecting any core business logic or backend functionality.

Test Suggestions

  • Verify that the new course button on the AI governance page correctly navigates to the 'understanding-ai-governance.html' page.
  • Ensure that the training registration include is successfully commented out and does not render unintentionally.
  • Perform visual regression tests to validate that the new SCSS styles (e.g., buttons, titles, animated elements) are applied consistently across different devices and browsers.
  • Check that the new product tour in 'what-is-validmind-register.qmd' displays all sections and interactive elements as expected.
  • Review responsiveness and layout integrity after renaming the section headers in the training listing.

@github-actions
Copy link
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DO NOT MERGE PR is not ready to be merged internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants