Skip to content

[wip]docs: add AI provider configuration and usage docs#3062

Open
olexii4 wants to merge 2 commits intomainfrom
AI_widget
Open

[wip]docs: add AI provider configuration and usage docs#3062
olexii4 wants to merge 2 commits intomainfrom
AI_widget

Conversation

@olexii4
Copy link
Copy Markdown
Contributor

@olexii4 olexii4 commented Apr 9, 2026

What does this pull request change?

Adds documentation for the AI Selector Widget feature introduced in che-dashboard#1505.

Administration Guide

  • Configuring AI providers (configuring-ai-providers.adoc) — procedure for creating the ai-tool-registry ConfigMap with providers, tools, and default selections.
  • AI provider API key Secret reference (ai-provider-api-key-secret-reference.adoc) — Secret schema, labels, annotations, naming convention, and manual creation.
  • CheCluster CR fields reference (checluster-custom-resource-fields-reference.adoc) — AI tool registry ConfigMap reference with provider and tool field tables.

End-User Guide

  • Using AI assistants in workspaces (using-ai-assistants-in-workspaces.adoc) — overview: default provider, multi-provider selection, AI Provider column in workspaces list, changing AI tool on existing workspaces.
  • Configuring an AI provider API key (configuring-an-ai-provider-api-key.adoc) — procedure with two paths: Create Workspace page and User Preferences > AI Providers Keys tab.
  • URL parameter for the AI provider (url-parameter-for-the-ai-provider.adoc) — ai-provider= factory URL parameter with comma-separated provider IDs.
Знімок екрана 2026-04-10 о 00 43 44 Знімок екрана 2026-04-10 о 00 49 59 Знімок екрана 2026-04-10 о 00 41 51

What issues does this pull request fix or reference?

eclipse-che/che#23796

Docs PR for che-dashboard#1505.

Specify the version of the product this pull request applies to

7.116.0

Pull Request checklist

The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.

  • Any procedure:
    • Successfully tested.
  • Any page or link rename:
    • The page contains a redirection for the previous URL.
    • Propagate the URL change in:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

@olexii4 olexii4 requested a review from amisevsk April 9, 2026 22:05
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 9, 2026

🎊 Navigate the preview: https://69dcc860e65b3d2f168fb961--eclipse-che-docs-pr.netlify.app 🎊

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 9, 2026

Click here to review and test in web IDE: Contribute

- Admin guide: configuring AI providers via ConfigMap, API key Secret reference,
  CheCluster CR fields for AI registry
- User guide: using AI assistants, configuring API keys (Create Workspace +
  User Preferences), AI provider URL parameter, workspace list column,
  changing AI tool on existing workspaces

Assisted-by: Claude Opus 4.6
Signed-off-by: Oleksii Orel <oorel@redhat.com>
- Fix section title levels in configuring-an-ai-provider-api-key.adoc
  (=== to == to follow expected sequence after = heading)
- Add end-user-guide: module prefix to cross-module xrefs in
  ai-provider-api-key-secret-reference.adoc and configuring-ai-providers.adoc
- Remove non-existent aiProviders and defaultAiProvider xrefs from
  checluster-custom-resource-fields-reference.adoc (AI config is
  ConfigMap-based, not CheCluster CR fields)

Assisted-by: Claude Opus 4.6
Signed-off-by: Oleksii Orel <oorel@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant