RelevanceAI / ask-relevance-widget

ChatGPT for your documentation, in your app 🧪

The Ask Relevance widget lets you embed an AI support assistant into your app in one line of code. ⚡️🔮🧪

Looking to embed Ask Relevance in your app?

Create a Relevance AI account, then follow the instructions to setup Ask Relevance for your data! You'll be able to preview Ask Relevance and copy the snippet needed to install the widget. If you're running into problems, reach out to support and we'll get back to you promptly!

Development

Bun is used for package management and running scripts.

# Install Bun if you don't have it:
curl -fsSL https://bun.sh/install | bash

# Install dependencies
bun i

# Start local dev server
bun run dev

The widget is built with Solid.js.

Trunk is used for formatting and linting. You can either:

• install the VS Code extension which handles setup and automatic format/lint automatically
• use the executable at the repo root (./trunk)

Check the docs for CLI instructions.

Releases

When a PR is opened into main, a binary is built automatically. When the PR is merged into main, we commit the binary to the repo and cut a release automatically.