docs: ✏️ update documentation for Show-PesterResult and Show-PesterResultTree

* Added detailed descriptions and examples for `Show-PesterResult` and `Show-PesterResultTree`.
* Updated the CHANGELOG to reflect the initial version and added notable features.
* Improved help documentation for better clarity and usability.

Author: HeyItsGilbert

CHANGELOG.md

@@ -5,5 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.1.0] Unreleased
+## [0.1.0] Initial Version
 
+### Added
+
+- `Show-PesterResult` renders a TUI that let's you navigate your Pester run
+  results. It shows item details as you navigate including the ability to from
+  Container to Block to Test.
+- `Show-PesterResultTree` renders your Pester run as a tree structure.

docs/en-US/Show-PesterResult.md

@@ -8,7 +8,7 @@ schema: 2.0.0
 # Show-PesterResult
 
 ## SYNOPSIS
-{{ Fill in the Synopsis }}
+Open a TUI to explore the Pester result object.
 
 ## SYNTAX
 
@@ -18,21 +18,24 @@ Show-PesterResult [[-PesterResult] <Run>] [-NoShortcutPanel] [-ProgressAction <A
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+Show a Pester result in a TUI (Text User Interface) using Spectre.Console.
+This function builds a layout with a header, a list of items, and a preview panel.
 
 ## EXAMPLES
 
-### Example 1
-```powershell
-PS C:\> {{ Add example code here }}
+### EXAMPLE 1
+```
+$pesterResult = Invoke-Pester -Path "path\to\tests.ps1" -PassThru
+Show-PesterResult -PesterResult $pesterResult
 ```
 
-{{ Add example description here }}
+This example runs Pester tests and opens a TUI to explore the results.
 
 ## PARAMETERS
 
 ### -PesterResult
-{{ Fill PesterResult Description }}
+The Pester result object to display.
+This should be a Pester Run object.
 
 ```yaml
 Type: Run
@@ -47,7 +50,7 @@ Accept wildcard characters: False
 ```
 
 ### -NoShortcutPanel
-{{ Fill NoShortcutPanel Description }}
+If specified, the shortcut panel will not be displayed at the bottom of the TUI.
 
 ```yaml
 Type: SwitchParameter
@@ -56,7 +59,7 @@ Aliases:
 
 Required: False
 Position: Named
-Default value: None
+Default value: False
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
@@ -81,11 +84,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## INPUTS
 
-### None
-
 ## OUTPUTS
 
-### System.Object
+### System.Void
 ## NOTES
 
 ## RELATED LINKS

docs/en-US/Show-PesterResultTree.md

@@ -8,7 +8,7 @@ schema: 2.0.0
 # Show-PesterResultTree
 
 ## SYNOPSIS
-{{ Fill in the Synopsis }}
+Show a Pester result in a tree format using Spectre.Console.
 
 ## SYNTAX
 
@@ -17,21 +17,26 @@ Show-PesterResultTree [[-PesterResult] <Run>] [-ProgressAction <ActionPreference
 ```
 
 ## DESCRIPTION
-{{ Fill in the Description }}
+This function takes a Pester result object and formats it into a tree structure
+using Spectre.Console.
+It is useful for visualizing the structure of Pester results
+such as runs, containers, blocks, and tests.
 
 ## EXAMPLES
 
-### Example 1
-```powershell
-PS C:\> {{ Add example code here }}
+### EXAMPLE 1
+```
+$pesterResult = Invoke-Pester -Path "path\to\tests.ps1" -PassThru
+Show-PesterResultTree -PesterResult $pesterResult
 ```
 
-{{ Add example description here }}
+This example runs Pester tests and displays the results in a tree format.
 
 ## PARAMETERS
 
 ### -PesterResult
-{{ Fill PesterResult Description }}
+The Pester result object to display.
+This should be a Pester Run object.
 
 ```yaml
 Type: Run
@@ -65,12 +70,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## INPUTS
 
-### None
-
 ## OUTPUTS
 
 ### System.Void
-
 ## NOTES
 
 ## RELATED LINKS

docs/en-US/about_PesterExplorer.help.md

@@ -2,58 +2,51 @@
 
 ## about_PesterExplorer
 
-```
-ABOUT TOPIC NOTE:
-The first header of the about topic should be the topic name.
-The second header contains the lookup name used by the help system.
-
-IE:
-# Some Help Topic Name
-## SomeHelpTopicFileName
-
-This will be transformed into the text file
-as `about_SomeHelpTopicFileName`.
-Do not include file extensions.
-The second header should have no spaces.
-```
-
 # SHORT DESCRIPTION
-{{ Short Description Placeholder }}
 
-```
-ABOUT TOPIC NOTE:
-About topics can be no longer than 80 characters wide when rendered to text.
-Any topics greater than 80 characters will be automatically wrapped.
-The generated about topic will be encoded UTF-8.
-```
+A TUI to explore Pester results.
 
 # LONG DESCRIPTION
-{{ Long Description Placeholder }}
 
-## Optional Subtopics
-{{ Optional Subtopic Placeholder }}
+A TUI built on top of PwshSpectreConsole to navigate and see your Pester run
+results.
 
 # EXAMPLES
-{{ Code or descriptive examples of how to leverage the functions described. }}
+
+To explore your result object you simply need to run `Show-PesterResult`
+
+```pwsh
+# Run Pester and make sure to PassThru the object
+$pester = Invoke-Pester .\tests\ -PassThru
+# Now run the TUI
+Show-PesterResult $p
+```
+
+You can also get a tree view of your pester results with
+`Show-PesterResultTree`.
+
+```pwsh
+# Run Pester and make sure to PassThru the object
+$pester = Invoke-Pester .\tests\ -PassThru
+# Now get that in a Tree view
+Show-PesterResultTree $p
+```
 
 # NOTE
-{{ Note Placeholder - Additional information that a user needs to know.}}
+
+This only works in PowerShell 7 because PwshSpectreConsole is only for 7.
 
 # TROUBLESHOOTING NOTE
-{{ Troubleshooting Placeholder - Warns users of bugs}}
 
-{{ Explains behavior that is likely to change with fixes }}
+Make sure your Pester Results are passed back with the `-PassThru` parameter.
 
 # SEE ALSO
-{{ See also placeholder }}
 
-{{ You can also list related articles, blogs, and video URLs. }}
+- [Pester](pester.dev)
+- [PwshSpectreConsole](pwshspectreconsole.com)
 
 # KEYWORDS
-{{List alternate names or titles for this topic that readers might use.}}
-
-- {{ Keyword Placeholder }}
-- {{ Keyword Placeholder }}
-- {{ Keyword Placeholder }}
-- {{ Keyword Placeholder }}
 
+- Pester
+- TDD
+- TUI