Skip to content

Fix online help #791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 29, 2025
Merged

Conversation

adityapatwardhan
Copy link
Member

PR Summary

This pull request enhances the handling of online help URIs in the MAML (Microsoft Assistance Markup Language) export process and updates the corresponding tests. The most significant changes include adding support for online help URIs in the MAML output and introducing new test cases to validate this functionality.

Enhancements to MAML export functionality:

  • src/MamlWriter/MamlHelpers.cs: Updated the ConvertCommandHelpToMamlHelpItems method to include an online help URI as a NavigationLink for commands, if available in the metadata. This ensures that the MAML output includes a link to the online version of the command's help documentation.

Updates to test cases:

  • test/Pester/ExportMamlCommandHelp.Tests.ps1: Modified the test validating the number of relatedLinks for the Get-Date command to account for the addition of the online help URI, increasing the expected count from 6 to 7.
  • test/Pester/ExportMamlCommandHelp.Tests.ps1: Added a new test case to verify that the exported MAML file contains the correct online help URI for the Get-Date command, ensuring the new functionality works as intended.

PR Context

Fix #788

@adityapatwardhan
Copy link
Member Author

/azp run

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

Copy link
Collaborator

@sdwheeler sdwheeler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@adityapatwardhan adityapatwardhan merged commit 46c016b into PowerShell:main Jul 29, 2025
8 checks passed
@adityapatwardhan adityapatwardhan deleted the FixOnlineHelp branch July 29, 2025 01:00
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.

Export-MamlCommandHelp omits the related link to the online content
2 participants