Dynamic Help Should have PSReadlineOption to open in either browser or "-ShowWindow" in addition to pager

Open
#2,270 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp, powershell
Domain
cli, desktop

Research direction

Start by tracing the dynamic help handling for the F1 trigger and the existing pager behavior in PSReadLine. Compare the requested PSReadLine option modes with ShowWindow and the Get-Help Get-Command -Online behavior; the work is done when both Windows ShowWindow and supplied online-URL flows are defined and implemented.

Written by the indexing model from the issue text.

Description

Issue-Enhancement Issue-Triaged

Description of the new feature/enhancement

The new dynamic help feature should have a psreadline option to display in the ShowWindow Dialog when pressing the trigger key (F1)
image

Obviously this would be Windows-Only until a cross-platform GUI is chosen.

It should also have an option to open it in a browser with -Online when F1 is pressed, if a online URL is supplied. Same action as Get-Help Get-Command -Online

Proposed technical implementation details (optional)

Dominant language
C#
Stars
4.4k
Forks
341
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from PowerShell/PSReadLine

All issues in PowerShell/PSReadLine

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.