Skip to content

Display setup instructions from README in plugin settings for each AI service provider #925

@jeffpaul

Description

@jeffpaul

Is your enhancement related to a problem? Please describe.

Pull the relevant AI service provider setup steps from the README (e.g., how to configure IBM Watson or OpenAI for specific features) and embed them as contextual helper content within the plugin’s settings screens.

When a user selects a provider for a feature like classification or language processing, the settings UI could display a collapsible help section or an info icon with instructions extracted from:

Designs

Currently, users must leave the admin interface and visit the README on GitHub to find setup instructions. Providing this information directly in the plugin settings improves the onboarding experience, reduces confusion, and makes it easier for non-technical users to enable features correctly.

Describe alternatives you've considered

  • Consider adding an "i" icon or collapsible help box for each AI service provider dropdown.
  • Where possible, match each settings section to the specific README block for that provider and feature.
  • Optionally use filters or a JSON config structure to manage the embedded setup steps for easier updates across releases.
  • This can be especially helpful during first-time setup or after switching between providers.

Code of Conduct

  • I agree to follow this project's Code of Conduct

Metadata

Metadata

Assignees

No one assigned

    Projects

    Status

    In Progress

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions