Add azure specific comment in docs (#1254)

docs/default-directory-layout.md

@@ -64,7 +64,7 @@ Contains files not consumed by *any* process. Only for the repo as reference ass
 Contains tests for the cmdlets. By default, it contains an example pester test and a httpipelinemock.ps1 script.
 
 ### /UX
-Contains metadata files for portal UX. Portal use these to display the usage of cmdlet for the resource in portal page.
+This directory is dedicated to Azure-specific content and includes metadata files essential for enhancing the user experience (UX) within the Azure portal. These files are utilized by the Azure portal to effectively present the usage of cmdlets related to specific resources on portal pages.
 
 ### /node_modules
 Contains the packages from which the projects depend on.

powershell/resources/assets/build-module.ps1

@@ -160,4 +160,10 @@ Export-TestStub -ModuleName $moduleName -ExportsFolder $exportsFolder -OutputFol
 Write-Host -ForegroundColor Green 'Creating example stubs...'
 Export-ExampleStub -ExportsFolder $exportsFolder -OutputFolder $examplesFolder
 
+if (Test-Path (Join-Path $PSScriptRoot 'generate-portal-ux.ps1'))
+{
+  Write-Host -ForegroundColor Green 'Creating ux metadata...'
+  . (Join-Path $PSScriptRoot 'generate-portal-ux.ps1')
+}
+
 Write-Host -ForegroundColor Green '-------------Done-------------'

powershell/resources/assets/generate-portal-ux.ps1

@@ -1,5 +1,8 @@
 # ----------------------------------------------------------------------------------
 ${$project.pwshCommentHeader}
+#
+# This Script will create a folder dedicated to Azure-specific content and includes metadata files essential for enhancing the user experience (UX) within the Azure portal. 
+# These files are utilized by the Azure portal to effectively present the usage of cmdlets related to specific resources on portal pages.
 # ----------------------------------------------------------------------------------
 param([switch]$NotIsolated)
 $ErrorActionPreference = 'Stop'

powershell/resources/assets/tools/Resources/how-to.md

@@ -48,6 +48,8 @@ There are multiple scripts created for performing different actions for developi
   - Generates the Markdown documents for the modules into the `docs` folder.
   - Same as `-Docs` in `build-module.ps1`.
   - This process is now integrated into `build-module.ps1` automatically. To disable, use `-NoDocs` when running `build-module.ps1`.
+- `generate-portal-ux.ps1`
+  - Generates a folder dedicated to Azure-specific content and includes metadata files essential for enhancing the user experience (UX) within the Azure portal.
 - `export-surface.ps1`
   - Generates Markdown documents for both the cmdlet surface and the model (class) surface of the module.
   - These files are placed into the `resources` folder.