Skip to content
UX Guide

Training UX Guide

Defining Contexts

UX Guide gathers information about your website through <UXGuide.Context> elements. You can include multiple such elements to provide detailed descriptions of your site.

Writing Effective Contexts

Contexts should be precise and relevant. The more unnecessary information you include, the less accurate the model’s understanding will be. Focus on providing clear, concise descriptions of your website and its pages.

Example: Pet Store

Imagine you’re running an online pet store called “PetPetals.” Here’s how you can introduce it to UX Guide:

<!doctype html>
<html lang="en">
  <head>
    <UxGuide.Context>
      Welcome to PetPetals, your one-stop shop for all pet needs! We offer food, toys,
      accessories, and professional grooming services for dogs, cats, and small animals.
    </UxGuide.Context>
  </head>
</html>

By default, <UXGuide.Context> elements remain invisible on your website.

Contexts for Specific Pages

You can also define contexts for specific routes. For example, to describe the reviews page:

<UxGuide.Context route="/reviews">
  Share your experience! Leave a review for any product you've purchased to help
  other pet owners. Reviews include a 1-5 star rating and optional comments.
</UxGuide.Context>

Disabling a Context

If you need to disable a <UXGuide.Context> temporarily, such as for debugging, simply add the ignore attribute:

<UxGuide.Context ignore>
  Internal note: Testing a new payment gateway, not yet live.
</UxGuide.Context>

This allows you to manage which information UX Guide processes without removing the element from your code.

Data Privacy

We only collect data from <UXGuide.Context> elements. No other HTML content or user data is gathered, ensuring your website’s privacy and security.