Skip to content

[Feature] Add "Ask AI" button to OpenFGA docs site #1155

@dyeam0

Description

@dyeam0

Overview

We want to add AI capabilities to OpenFGA docs to help users more easily get answers and information using an AI-backed solution. The objective is to add an AI chat interface directly to the OpenFGA docs site.

Details

As part of CNCF, the OpenFGA project has access to the Kapa.AI platform. Kapa.AI provides AI assistants for documentation. The objective is to add an "Ask AI" button next to the current "Search" box. The "Ask AI" button should bring up the chat interface (ie. chat dialog window). Users can chat with the AI assistant in natural language and the LLM will respond with answers that have been trained on the OpenFGA documentation.

References

Examples of this functionality:

To integrate

// docusaurus.config.js
const config = {
  // ... other config options

  scripts: [
    {
      src: "https://widget.kapa.ai/kapa-widget.bundle.js",
      "data-website-id": "YOUR_WEBSITE_ID",
      "data-project-name": "OpenFGA",
      "data-project-color": "#79ED83",
      "data-project-logo": "https://openfga.dev/img/openfga_logo.svg",
      async: true,
    },
  ],

  // ... rest of your config
};

module.exports = config;

Make sure to update the CSP as indicated in: https://docs.kapa.ai/integrations/faq#what-csp-errors-look-like

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Projects

Status

On deck

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions