Incorporated Fabrice's comments

pabel-rh · pabel-rh · commit 4e42bae40f1d · 2025-10-07T10:46:31.000+05:30
diff --git a/assemblies/assembly-customizing-the-appearance.adoc b/assemblies/assembly-customizing-the-appearance.adoc
@@ -28,7 +28,7 @@ include::modules/customizing-the-appearance/proc-customize-rhdh-theme-mode.adoc[
 include::modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.adoc[leveloffset=+1]
 
 
-include::modules/customizing-the-appearance/con-customize-rhdh-sidebar-menuitems.adoc[leveloffset=+1]
+include::modules/customizing-the-appearance/con-about-rhdh-sidebar-menuitems.adoc[leveloffset=+1]
 
 include::modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc[leveloffset=+2]
 
diff --git a/modules/configuring-the-global-header/con-quicklinks-and-starred-items-in-global-header.adoc b/modules/configuring-the-global-header/con-quicklinks-and-starred-items-in-global-header.adoc
@@ -9,7 +9,7 @@ The *Quicklinks* matrix, organized by sections (for example, Documentation or De
 
 The default configuration includes the following components:
 
-* *StarredDropdown*: Displays the *Starred Items* menu in the global header by default, as shown in the following configuration:
+`StarredDropdown`:: Display the *Starred Items* menu in the global header by default, as shown in the following configuration:
 +
 [source,yaml]
 ----
@@ -21,7 +21,7 @@ The default configuration includes the following components:
       priority: 85
 ----
 
-* *ApplicationLauncherDropdown*: Provides the *Quicklinks* matrix (application launcher) by default, as shown in the following configuration:
+`ApplicationLauncherDropdown`:: Provide the *Quicklinks* matrix (application launcher) by default, as shown in the following configuration:
 +
 [source,yaml]
 ----
@@ -33,7 +33,7 @@ The default configuration includes the following components:
       priority: 82
 ----
 
-* *MenuItemLink entries*: Define sections, titles, icons, and links within the *Quicklinks* matrix. The default configuration includes links to the {product-short} documentation and an {product-very-short} Local, as shown in the following configurations:
+`MenuItemLink entries`:: Define sections, titles, icons, and links within the *Quicklinks* matrix. The default configuration includes links to the {product-short} documentation and an {product-very-short} Local, as shown in the following configurations:
 +
 [source,yaml,subs="+attributes"]
 ----
diff --git a/modules/configuring-the-global-header/proc-customize-rhdh-global-header.adoc b/modules/configuring-the-global-header/proc-customize-rhdh-global-header.adoc
@@ -76,10 +76,18 @@ For more information about enabling dynamic plugins, see {installing-and-viewing
 ----
 where:
 
-  *search*:: Hides the *Search* modal in the sidebar menu. Change it to `true` to display the *Search* modal in the sidebar.
-  *settings*:: Hides the *Settings* button in the sidebar menu. Change it to `true` to display the *Settings* button in the sidebar.
-  `default.main-menu-items`:: Hides the *Self-service* button from the sidebar menu. Remove this field to display the *Self-service* button in the sidebar.
-  *position*:: Defines the position of the header. Options: `above-main-content` or `above-sidebar`.
+`search`::
+Enter `false` to hide the *Search* modal in the sidebar menu.
+Enter `true` to display the *Search* modal in the sidebar menu.
+`settings`::
+Enter `false` to hides the *Settings* button in the sidebar menu. 
+Enter `true` to display the *Settings* button in the sidebar menu.
+`default.main-menu-items`::
+Enter this field to hide the *Self-service* button from the sidebar menu.
+Remove this field to display the *Self-service* button in the sidebar menu.
+`position`::
+Enter `above-main-content` to position the header above the main content.
+Enter `above-sidebar` to position the header above the side bar.
 
 To extend the functionality of the default global header, include any the following attributes in your global header entry:
 
diff --git a/modules/configuring-the-global-header/proc-displaying-preferred-username-in-profile-drop-down.adoc b/modules/configuring-the-global-header/proc-displaying-preferred-username-in-profile-drop-down.adoc
@@ -7,7 +7,7 @@ You can display the preferred username in the global header profile drop-down li
 
 .Procedure
 
-* When you configure `spec.profile.displayName`, use the following code:
+. To configure `spec.profile.displayName`, use the following code:
 +
 [source,yaml,subs="+attributes,+quotes"]
 ----
@@ -25,7 +25,7 @@ spec:
   memberOf: [janus-authors]
 ----
 
-* When you do not configure `spec.profile.displayname` but configure `metadata.title`, use the following code:
+. To configure `metadata.title` rather than `spec.profile.displayname`, use the following code:
 +
 [source,yaml,subs="+attributes,+quotes"]
 ----
@@ -40,7 +40,7 @@ spec:
   memberOf: [janus-authors]
 ----
 
-* When you do not configure the `spec.profile.displayname` and the `metadata.title`, use the following code:
+. To configure neither `spec.profile.displayname` or `metadata.title`, use the following code:
 +
 [source,yaml,subs="+attributes,+quotes"]
 ----
diff --git a/modules/configuring-the-global-header/ref-mount-points.adoc b/modules/configuring-the-global-header/ref-mount-points.adoc
@@ -11,7 +11,7 @@ Controls the header position. Use `config.position` to set placement as either `
 global.header/component::
 Configures header components. Use `config.priority` to set the order of components, and pass properties (including CSS styles) via `config.props`.
 
-* *Self-service* button
+`Self-service* button`::
 +
 [source,yaml,subs="attributes,quotes"]
 ----
@@ -25,7 +25,7 @@ Configures header components. Use `config.priority` to set the order of componen
       to: create
 ----
 
-* Spacer element
+`Spacer element`::
 +
 [source,yaml]
 ----
@@ -37,7 +37,7 @@ Configures header components. Use `config.priority` to set the order of componen
       growFactor: 0
 ----
 
-* Divider element
+`Divider element`::
 +
 [source,yaml]
 ----
diff --git a/modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc b/modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc
@@ -34,8 +34,9 @@ app:
         text: 'Browse Templates'
         link: '/create'
 ----
-`title`:: (Required) The display title for the quickstart step.
-`description`:: (Required) A brief description of what the step covers.
-`icon`:: Icon identifier (supports Material UI icons).
-`text`: CTA button text.
-`link`:: CTA target URL or route.
+`title`:: Enter the display title for the quickstart step.
+`description`:: Enter the brief description of what the step covers.
+`icon`:: (Optional) Enter the icon identifier (supports Material UI icons).
+`cta`::
+`text`::: (Optional) Enter the CTA button text.
+`link`::: (Optional) Enter the CTA target URL or route.
diff --git a/modules/customizing-the-appearance/con-about-rhdh-sidebar-menuitems.adoc b/modules/customizing-the-appearance/con-about-rhdh-sidebar-menuitems.adoc
@@ -1,6 +1,6 @@
 :_mod-docs-content-type: CONCEPT
 
-[id="con-customize-rhdh-sidebar-menuitems_{context}"]
+[id="con-about-rhdh-sidebar-menuitems_{context}"]
 = About the sidebar menu items for your {product-short} instance
 
 The sidebar menu in {product} consists of two main parts that you can configure:
diff --git a/modules/customizing-the-appearance/proc-configuring-dynamic-plugin-menuitem.adoc b/modules/customizing-the-appearance/proc-configuring-dynamic-plugin-menuitem.adoc
@@ -40,13 +40,14 @@ Enter a unique name in the main sidebar navigation for either a standalone menu
 // Update <4> for release 1.6 as this option (currently a workaround) would be added as a functionality. RHIDP-6333.
 
 `priority`:: 
-(Optional) Sets the order in which menu items appear in the sidebar. The default priority is 0, which places the item at the bottom of the list. A higher priority value places the item higher in the sidebar. You can define this field for each section.
+(Optional) Enter an integer value to set the order in which menu items appear in the sidebar.
 
 `parent`:: 
 (Optional) Enter the parent menu item under which the current item is nested. If this field is used, the parent menu item must be defined elsewhere in the `menuItems` configuration of any enabled plugin. You can define this field for each section.
 
 `enabled`:: 
-(Optional) If this field is used to hide the menu item from the sidebar, set the value to `false`. To display the menu item in the sidebar, set the value to `true`.
+(Optional) Enter `false` to hide the menu item from the sidebar. 
+Enter `true` to display the menu item in the sidebar.
 
 +
 [source,yaml,subs="+attributes"]
@@ -71,22 +72,16 @@ dynamicPlugins:
           priority: 100
 ----
 `my-plugin`:: 
-Matches the value of the `path` field in `dynamicRoutes`.
+Enter the value of the `path` field in `dynamicRoutes`.
 
 `priority`:: 
-Controls order of plugins under the parent menu item.
+Enter an integer value to set the order in which plugins appear in the parent menu item.
 
 `parent`:: 
-Nests this plugin under the `favorites` parent menu item.
+Enter the parent menu item id to nest this plugin under, such as `favorites`.
 
 `favorites`:: 
 Configuration for the parent menu item.
 
-`icon`:: 
-Displays the `favorite` icon from the {product-very-short} system icons.
-
 `title`:: 
-Displays the title name for the parent menu item.
-
-`priority`:: 
-Order of the `favourites` menu item in the sidebar.
+Displays the title name for the parent menu item.
diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.adoc
@@ -12,8 +12,8 @@ app:
     fullLogo: ${BASE64_EMBEDDED_FULL_LOGO} <1>
     iconLogo: ${BASE64_EMBEDDED_ICON_LOGO} <2>
 ----
-`fullLogo`:: The logo on the expanded (pinned) sidebar and expects a base64 encoded image.
-`iconLogo`:: The logo on the collapsed (unpinned) sidebar and expects a base64 encoded image.
+`fullLogo`:: Enter the logo on the expanded (pinned) sidebar as a base64 encoded image.
+`iconLogo`:: Enter the logo on the collapsed (unpinned) sidebar as a base64 encoded image.
 +
 You can format the `BASE64_EMBEDDED_FULL_LOGO` environment variable as follows:
 +
diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-page-theme.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-page-theme.adoc
@@ -30,12 +30,12 @@ app:
             shape: none
 # ...
 ----
-`light`:: The theme mode, for example, `light` or `dark`
-`default`:: The `yaml` header for the default page theme configuration
-`backgroundColor`:: The color of the page header background, for example, `#ffffff` or `white`
-`fontColor`:: The color of the text in the page header, for example, `#000000` or `black`
-`shape`:: The pattern on the page header, for example, `wave`, `round`, or `none`
-`apis::` The `yaml` header for a specific page theme configuration, for example, `apis`, `home`
+`light`:: Enter the theme mode, such as `light` or `dark`.
+`default`:: Enter the default page theme configuration
+`backgroundColor`::: Enter the page header background color, such as `#ffffff` or `white`.
+`fontColor`::: Enter the page header text color, such as `#000000` or `black`.
+`shape`::: Enter the page header pattern, such as `wave`, `round`, or `none`.
+`apis::` Enter the page id to configure, such as `apis` or `home`.
 
 //The page theme name depends on the plugin that you are customizing the page header for.
 //can include information about this topic in the future.
diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-palette.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-palette.adoc
@@ -30,12 +30,10 @@ app:
             backgroundColor: [<dark_background_color_1>, <dark_background_color_2>]
 # ...
 ----
-`light:palette:primary:main`:: The main primary color for the light color palette, for example, `#ffffff` or `white`
-`light:palette:navigation:indicator`:: The color of the navigation indicator for the light color palette, which is a vertical bar that indicates the selected tab in the navigation panel, for example, `#FF0000` or `red`
-`light:pageTheme:default:backgroundColor`:: The background color for the default page theme for the light color palette, for example, `#ffffff` or `white`
-`dark:palette:primary:main`:: The main primary color for the dark color palette, for example, `#000000` or `black`
-`dark:palette:navigation:indicator`:: The color of the navigation indicator for the dark color palette, which is a vertical bar that indicates the selected tab in the navigation panel, for example, `#FF0000` or `red`
-`dark:pageTheme:default:backgroundColor`:: The background color for the default page theme for the dark color palette, for example, `#000000` or `black`
+`light|dark`:: Enter the theme name: `light` or `dark`.
+`palette.primary:main`::: Enter the palette main primary color, such as `#ffffff` or `white`.
+`palette.navigation:indicator`::: Enter the palette navigation indicator color, which is a vertical bar that indicates the selected tab in the navigation panel, such as `#FF0000` or `red`.
+`pageTheme:default:backgroundColor`::: Enter the default page theme background color, such as `#ffffff` or `white`.
 
 .Additional resources
 * xref:proc-customizing-rhdh-theme-mode_{context}[]
diff --git a/modules/customizing-the-appearance/proc-customize-rhdh-theme-mode.adoc b/modules/customizing-the-appearance/proc-customize-rhdh-theme-mode.adoc
@@ -5,16 +5,16 @@
 
 You can choose one of the following theme modes for your {product-short} instance:
 
-* *LIGHT THEME*
-* *DARK THEME*
-* *AUTO*
+* *Light*
+* *Dark*
+* *Auto*
 
 [NOTE]
 ====
 In {product-short}, theme configurations are used to change the look and feel of different UI components. So, you might notice changes in different UI components, such as buttons, tabs, sidebars, cards, and tables along with some changes in background color and font used on the {product-very-short} pages.
 ====
 
-The default theme mode is *AUTO*, which automatically sets the light or dark theme based on your system preferences.
+The default theme mode is *Auto*, which automatically sets the light or dark theme based on your system preferences.
 
 .Prerequisites
 
@@ -23,7 +23,7 @@ The default theme mode is *AUTO*, which automatically sets the light or dark the
 .Procedure
 
 . From the {product-short} web console, click *Settings*.
-. From the *Appearance* panel, click *LIGHT THEME*, *DARK THEME*, or *AUTO* to change the theme mode.
+. From the *Appearance* panel, click *Light*, *Dark*, or *Auto* to change the theme mode.
 +
 image::user-guide/custom-theme-mode-1.png[]
 
diff --git a/modules/customizing-the-appearance/proc-loading-custom-theme-using-dynamic-plugin.adoc b/modules/customizing-the-appearance/proc-loading-custom-theme-using-dynamic-plugin.adoc
@@ -36,7 +36,9 @@ dynamicPlugins:
           icon: someIconReference
           importName: lightThemeProvider
 ----
-`id`:: Set your theme ID by specifying the desired value. Optionally, override the default {product-short} themes by using the following ID values: `light` to replace the default light theme, or `dark` to replace the default dark theme.
+`id`:: Enter your theme ID, such as `my_theme`. 
+Enter `dark` to override the default {product-short} dark theme.
+Enter `light` to override the default {product-short} light theme.
 
 .Verification
 
diff --git a/modules/customizing-the-appearance/proc-modifying-or-adding-rhdh-custom-menuitem.adoc b/modules/customizing-the-appearance/proc-modifying-or-adding-rhdh-custom-menuitem.adoc
@@ -61,11 +61,11 @@ default.main-menu-items:
           to: /references
           enabled: true
 ----
-`icon`:: Specifies if you want to change the icon default menu item for the catalog.
-`title`:: Specifies an empty string `" "` to hide the learning path from the default sidebar.
-`default.parentlist`:: Introduces the parent menu item.
-`parent`:: Nests home menu under the `default.parentlist` parent menu item.
-`title`:: Specifies a name for `default.references`
-`icon`:: Displays the `school` icon.
-`to`:: Redirects `default.references` to the `/references` page.
-`enabled`:: (Optional) If this field is used to display the menu item in the sidebar, set the value to `true`. To hide the menu item from the sidebar, set the value to `false`.
+`icon`:: (Optional) Enter the icon name, such as `category`, bookmarks`, `school`, etc. to change the default icon.
+`title`:: Enter an empty string `''` to hide the learning path from the default sidebar.
+`default.parentlist`:: Enter the parent menu items.
+`parent`:: Enter the parent menu under which to nest the the menu entry, such as `default.parentlist`.
+`title`:: Enter the menu entry name, such as `My Catalog`, `Overview` or `References`.
+`to`:: Enter the page to redirect to. For example, `default.references` redirects to the `/references` page.
+`enabled`:: (Optional) Enter `true` to display the menu item in the sidebar. 
+Enter `false` to hide the menu item from the sidebar.

Original file line number	Diff line number	Diff line change
`@@ -12,8 +12,8 @@ app:`
`12`	`12`	`fullLogo: ${BASE64_EMBEDDED_FULL_LOGO} <1>`
`13`	`13`	`iconLogo: ${BASE64_EMBEDDED_ICON_LOGO} <2>`
`14`	`14`	`----`
`15`		-`fullLogo`:: The logo on the expanded (pinned) sidebar and expects a base64 encoded image.
`16`		-`iconLogo`:: The logo on the collapsed (unpinned) sidebar and expects a base64 encoded image.
	`15`	+`fullLogo`:: Enter the logo on the expanded (pinned) sidebar as a base64 encoded image.
	`16`	+`iconLogo`:: Enter the logo on the collapsed (unpinned) sidebar as a base64 encoded image.
`17`	`17`	`+`
`18`	`18`	You can format the `BASE64_EMBEDDED_FULL_LOGO` environment variable as follows:
`19`	`19`	`+`