Skip to content

Commit bd0f738

Browse files
committed
docs: fix broken cross-references and section levels in AI docs
- 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>
1 parent 3f6dba4 commit bd0f738

4 files changed

Lines changed: 4 additions & 6 deletions

File tree

modules/administration-guide/pages/ai-provider-api-key-secret-reference.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,5 +109,5 @@ EOF
109109
.Additional resources
110110

111111
* xref:configuring-ai-providers.adoc[]
112-
* xref:mounting-secrets.adoc[Mounting Secrets (end-user guide)]
112+
* xref:end-user-guide:mounting-secrets.adoc[Mounting Secrets (end-user guide)]
113113
* link:https://devfile.io/docs/2.2.0/what-is-a-devfile[DevWorkspace Operator documentation]

modules/administration-guide/pages/checluster-custom-resource-fields-reference.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,9 @@ This section describes all fields available to customize the `CheCluster` Custom
1111

1212
* xref:a-minimal-checluster-custom-resource-example[]
1313
* xref:checluster-custom-resource-devEnvironments-settings[]
14-
** xref:checluster-custom-resource-devEnvironments-aiProviders-settings[]
1514
** xref:checluster-custom-resource-devEnvironments-allowedSources-settings[]
1615
** xref:checluster-custom-resource-devEnvironments-containerBuildConfiguration-settings[]
1716
** xref:checluster-custom-resource-devEnvironments-containerRunConfiguration-settings[]
18-
** xref:checluster-custom-resource-devEnvironments-defaultAiProvider-settings[]
1917
** xref:checluster-custom-resource-devEnvironments-defaultNamespace-settings[]
2018
** xref:checluster-custom-resource-devEnvironments-defaultPlugins-settings[]
2119
** xref:checluster-custom-resource-devEnvironments-editorsDownloadUrls-settings[]

modules/administration-guide/pages/configuring-ai-providers.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,4 +108,4 @@ When an administrator updates the registry (for example, removes a tool or chang
108108
.Additional resources
109109

110110
* xref:ai-provider-api-key-secret-reference.adoc[]
111-
* xref:using-ai-assistants-in-workspaces.adoc[]
111+
* xref:end-user-guide:using-ai-assistants-in-workspaces.adoc[]

modules/end-user-guide/pages/configuring-an-ai-provider-api-key.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Configure an AI provider API key so that it is automatically injected as an envi
1818

1919
You can configure an API key from the *Create Workspace* page or from *User Preferences*.
2020

21-
=== From the Create Workspace page
21+
== From the Create Workspace page
2222

2323
. Navigate to *Create Workspace*.
2424
. In the *AI Provider* section, expand *Choose an AI Provider*.
@@ -27,7 +27,7 @@ You can configure an API key from the *Create Workspace* page or from *User Pref
2727
+
2828
A *Key configured* badge is displayed on the provider card.
2929

30-
=== From User Preferences
30+
== From User Preferences
3131

3232
. Navigate to *User Preferences > AI Providers Keys*.
3333
. Click *Add API Key*.

0 commit comments

Comments
 (0)