Skip to content
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

Spelling and misc MD fixes #275

Merged
merged 1 commit into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ An agent plugin is responsible for managing its own chat history.
This is the implementation of AI Shell. It consists of the following components:

- ReadLine
- Renders (mardown render, stream render, paging render)
- Renders (markdown render, stream render, paging render)
- Plugin management
- Host (a range of utility methods for writing output and interactive prompting)
- Command runner and built-in commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ First step is to create a new classlib project.
### Step 2: Add the necessary packages

Within the newly created project, you need to install the [AIShell.Abstraction][06] package from the
Nuget gallery. Install the Nuget package using the following command:
NuGet gallery. Install the NuGet package using the following command:

```shell
dotnet add package AIShell.Abstraction --version 1.0.0-preview.1
Expand All @@ -66,7 +66,7 @@ following XML:
```

> [!IMPORTANT]
> Be sure to check you are on the latest version from the Nuget gallery.
> Be sure to check you are on the latest version from the NuGet gallery.

### Step 3: Implement the agent class

Expand Down Expand Up @@ -205,7 +205,7 @@ public sealed class OllamaAgent : ILLMAgent
```

For the initial implementation, the agent to returns "Hello World!" to prove that you created the
correct interfaces. You will also add a `try-catch` block to catch and handle any expections when
correct interfaces. You will also add a `try-catch` block to catch and handle any exceptions when
the user tries to cancel the operation.

Add the following code to your `Chat` method.
Expand Down Expand Up @@ -499,4 +499,4 @@ in the `agents` folder of the base directory of `aish.exe`, the agent will be lo
[03]: https://github.com/PowerShell/ProjectMercury/discussions/categories/agent-sharing
[04]: https://github.com/PowerShell/ProjectMercury/shell/agents/AIShell.Ollama.Agent
[05]: https://github.com/PowerShell/ProjectMercury/shell/README.md
[06]: https://www.nuget.org/packages/AIShell.Abstraction/1.0.0-preview.1
[06]: https://www.nuget.org/packages/AIShell.Abstraction/1.0.0-preview.1
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ The following example copies the all the code to a file.
### `/code post`

Post the n-th (1-based) code snippet to the connected command-line shell. Post all the code
when` <n>` isn't specified.
when `<n>` isn't specified.

Usage:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,5 +134,5 @@ a username and password for the `net use` command.
}
```

The argument transformer converst the **PSCredential** object to `/USER:username password` for the
The argument transformer converts the **PSCredential** object to `/USER:username password` for the
`net use` command.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ title: AvoidGlobalFunctions
Globally scoped functions override existing functions within the sessions with matching names. This
name collision can cause difficult to debug issues for consumers of modules.


To understand more about scoping, see `Get-Help about_Scopes`.

## How
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ There are also implicit aliases. When PowerShell cannot find the cmdlet name, it
Every PowerShell author learns the actual command names, but different authors learn and use
different aliases. Aliases can make code difficult to read, understand and impact availability.

Using the full command name makes it eaiser to maintain your scripts in the the future.
Using the full command name makes it easier to maintain your scripts in the the future.

Using the full command names also allows for syntax highlighting in sites and applications like
GitHub and Visual Studio Code.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ Enforce a new line character after an open brace. The default value is true.
#### IgnoreOneLineBlock: bool (Default value is `$true`)

Indicates if open braces in a one line block should be ignored or not. For example,
` $x = if ($true) { 'blah' } else { 'blah blah' }`, if the property is set to true then the rule
`$x = if ($true) { 'blah' } else { 'blah blah' }`, if the property is set to true then the rule
doesn't fire a violation.
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ if ($a = Get-Something) # Only execute action if command returns something and a
}
```

## Implicit suppresion using Clang style
## Implicit suppression using Clang style

There are some rare cases where assignment of variable inside an `if` statement is by design.
Instead of suppressing the rule, one can also signal that assignment was intentional by wrapping the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Rules = @{

### Parameters

- `Enable`: **bool** (Default valus is `$true`)
- `Enable`: **bool** (Default value is `$true`)

Enable or disable the rule during ScriptAnalyzer invocation.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ function Update-Item
```

<!-- link references -->
[01]: /powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands
[01]: /powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ authors to provide the desired interactive experience while using the cmdlet.

## Example

### Wrong:
### Wrong

```powershell
function foo {
Expand All @@ -30,7 +30,7 @@ function foo {
}
```

### Correct:
### Correct

```powershell
function foo {
Expand Down
2 changes: 1 addition & 1 deletion reference/docs-conceptual/PlatyPS/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ There are two major versions of PlatyPS.
[04]: https://github.com/xoofx/markdig
[05]: https://wikipedia.org/wiki/Markdown
[06]: https://wikipedia.org/wiki/Microsoft_Assistance_Markup_Language
[07]: https://www.powershellgallery.com/packages/Microsoft.PowerShell.PlatyPS
[07]: https://www.powershellgallery.com/packages/Microsoft.PowerShell.PlatyPS
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Export-CrescendoCommand [-command] <Command[]> [-targetDirectory <String>] [-Wha
```

### SingleFile

```
Export-CrescendoCommand [-command] <Command[]> -fileName <String> [-Force] [-WhatIf] [-Confirm]
[<CommonParameters>]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,31 +20,41 @@ PowerShell cmdlets that are easier to use in automation and packaged to share wi
## Microsoft.PowerShell.Crescendo Cmdlets

### [Export-CrescendoCommand](Export-CrescendoCommand.md)

Creates JSON configuration files for Crescendo **Command** objects.

### [Export-CrescendoModule](Export-CrescendoModule.md)

Creates a module from PowerShell Crescendo JSON configuration files

### [Export-Schema](Export-Schema.md)

Exports the JSON schema for command configuration as a PowerShell object.

### [Import-CommandConfiguration](Import-CommandConfiguration.md)

Import a PowerShell Crescendo json file.

### [New-CrescendoCommand](New-CrescendoCommand.md)

Creates a PowerShell command object.

### [New-ExampleInfo](New-ExampleInfo.md)

Creates a PowerShell object representing an example used in a Crescendo command object.

### [New-OutputHandler](New-OutputHandler.md)

Creates a PowerShell object representing a Crescendo output handler.

### [New-ParameterInfo](New-ParameterInfo.md)

Creates a PowerShell object representing a Crescendo Parameter definition.

### [New-UsageInfo](New-UsageInfo.md)

Creates a PowerShell object representing a Crescendo Usage definition.

### [Test-IsCrescendoCommand](Test-IsCrescendoCommand.md)

Tests whether a cmdlet was created by Crescendo.
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ New-OutputHandler
## DESCRIPTION

Creates a PowerShell object representing a Crescendo output handler. You can assign values to the
properties of the object. The resulting object can be added to the **OutputHanders** property of a
properties of the object. The resulting object can be added to the **OutputHandlers** property of a
command object or it can be converted to JSON to be inserted in the configuration file.

## EXAMPLES
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,4 +102,3 @@ Updates an imported Markdown command file with the information from session cmdl
### [Update-MarkdownModuleFile](Update-MarkdownModuleFile.md)

Updates the Markdown module file.

Original file line number Diff line number Diff line change
Expand Up @@ -20,34 +20,45 @@ vaults are registered to the current logged in user context, and are available o
## Microsoft.PowerShell.SecretManagement Cmdlets

### [Get-Secret](Get-Secret.md)

Finds and returns a secret by name from registered vaults.

### [Get-SecretInfo](Get-SecretInfo.md)

Finds and returns metadata information about secrets in registered vaults.

### [Get-SecretVault](Get-SecretVault.md)

Finds and returns registered vault information.

### [Register-SecretVault](Register-SecretVault.md)

Registers a SecretManagement extension vault module for the current user.

### [Remove-Secret](Remove-Secret.md)

Removes a secret from a specified registered extension vault.

### [Set-Secret](Set-Secret.md)

Adds a secret to a SecretManagement registered vault.

### [Set-SecretInfo](Set-SecretInfo.md)

Adds or replaces additional secret metadata to a secret currently stored in a vault.

### [Set-SecretVaultDefault](Set-SecretVaultDefault.md)

Sets the provided vault name as the default vault for the current user.

### [Test-SecretVault](Test-SecretVault.md)

Runs an extension vault self test.

### [Unlock-SecretVault](Unlock-SecretVault.md)

Unlocks an extension vault so that it can be access in the current session.

### [Unregister-SecretVault](Unregister-SecretVault.md)

Un-registers an extension vault from SecretManagement for the current user.
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Locale: en-US
# Microsoft.PowerShell.SecretStore Module

## Description

Local secure store extension vault for Microsoft.PowerShell.SecretManagement module.

> [!NOTE]
Expand All @@ -24,16 +25,21 @@ Local secure store extension vault for Microsoft.PowerShell.SecretManagement mod
## Microsoft.PowerShell.SecretStore Cmdlets

### [Get-SecretStoreConfiguration](Get-SecretStoreConfiguration.md)

Returns SecretStore configuration information.

### [Reset-SecretStore](Reset-SecretStore.md)

Resets the SecretStore by deleting all secret data and configuring the store with default options.

### [Set-SecretStoreConfiguration](Set-SecretStoreConfiguration.md)

Configures the **SecretStore**.

### [Set-SecretStorePassword](Set-SecretStorePassword.md)

Replaces the current SecretStore password with a new one.

### [Unlock-SecretStore](Unlock-SecretStore.md)

Unlocks SecretStore with the provided password.
3 changes: 3 additions & 0 deletions reference/ps-modules/PSScriptAnalyzer/PSScriptAnalyzer.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,13 @@ checks the quality of PowerShell code by running a set of rules.
## PSScriptAnalyzer Cmdlets

### [Get-ScriptAnalyzerRule](Get-ScriptAnalyzerRule.md)

Gets the script analyzer rules on the local computer.

### [Invoke-Formatter](Invoke-Formatter.md)

Formats a script text based on the input settings or default settings.

### [Invoke-ScriptAnalyzer](Invoke-ScriptAnalyzer.md)

Evaluates a script or module based on selected best practice rules
1 change: 1 addition & 0 deletions reference/ps-modules/PlatyPS/Get-MarkdownMetadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ The first command gets the contents of a file, and stores them in the `$Markdown
The second command retrieves metadata from the string in $Metadata.

### Example 3: Get metadata from all files in a folder

```
PS C:\> Get-MarkdownMetadata -Path ".\docs"

Expand Down
2 changes: 1 addition & 1 deletion reference/ps-modules/PlatyPS/New-MarkdownAboutHelp.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ New-MarkdownAboutHelp [-OutputFolder] <String> [[-AboutName] <String>] [<CommonP

The `New-MarkdownAboutHelp` cmdlet generates a Markdown file that is prepopulated with the standard elements of an About Topic.
The cmdlet copies the template MD, renames headers and file name according to the **AboutName** parameter,
and deposits the file in the directory designated by the **OutputFoler** parameter.
and deposits the file in the directory designated by the **OutputFolder** parameter.

The About Topic can be converted to Txt format.
About topics must be in txt format or the PowerShell Help engine will not be able to parse the document.
Expand Down
1 change: 1 addition & 0 deletions reference/ps-modules/PlatyPS/New-MarkdownHelp.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ New-MarkdownHelp -Command <String[]> [-Session <PSSession>] [-Force] [-Alphabeti
```

### FromMaml

```
New-MarkdownHelp -MamlFile <String[]> [-ConvertNotesToList] [-ConvertDoubleDashLists] [-Force]
[-AlphabeticParamsOrder] [-Metadata <Hashtable>] -OutputFolder <String> [-NoMetadata] [-UseFullTypeName]
Expand Down
11 changes: 10 additions & 1 deletion reference/ps-modules/PlatyPS/platyPS.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,32 +20,41 @@ The platyPS module allows you to create PowerShell External Help in Markdown.
## platyPS Cmdlets

### [Get-HelpPreview](Get-HelpPreview.md)

Displays your generated external help as **Get-Help** output.

### [Get-MarkdownMetadata](Get-MarkdownMetadata.md)

Gets metadata from the header of a markdown file.

### [Merge-MarkdownHelp](Merge-MarkdownHelp.md)

Merge multiple markdown versions of the same cmdlet into a single markdown file.

### [New-ExternalHelp](New-ExternalHelp.md)

Creates external help file based on markdown supported by PlatyPS.

### [New-ExternalHelpCab](New-ExternalHelpCab.md)

Generates a .cab file.

### [New-MarkdownAboutHelp](New-MarkdownAboutHelp.md)

Generates a new About Topic MD file from template.

### [New-MarkdownHelp](New-MarkdownHelp.md)

Creates help in markdown format.

### [New-YamlHelp](New-YamlHelp.md)

Converts Markdown help into YAML to be read easily by external tools

### [Update-MarkdownHelp](Update-MarkdownHelp.md)

Update PlatyPS markdown help files.

### [Update-MarkdownHelpModule](Update-MarkdownHelpModule.md)
Update all files in a markdown help module folder.

Update all files in a markdown help module folder.