Workflows to generate and publish documentation and online help#199
Merged
jakehildreth merged 20 commits intojakehildreth:testingfrom Dec 26, 2024
Merged
Workflows to generate and publish documentation and online help#199jakehildreth merged 20 commits intojakehildreth:testingfrom
jakehildreth merged 20 commits intojakehildreth:testingfrom
Conversation
… into se-mkdocs-01
jakehildreth
approved these changes
Dec 26, 2024
Owner
jakehildreth
left a comment
There was a problem hiding this comment.
I understand this PR this much:
- It is not malicious.
- It does what Sam has described it to do.
- It makes Sam the official CI/CD guy for Locksmith.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces several new workflows, scripts, and documentation updates to improve the automation and documentation processes for the
Locksmithmodule. The most important changes include adding workflows for creating external help and deploying MkDocs, updating documentation configurations, and adding scripts for generating and repairing documentation.New Workflows:
.github/workflows/Create External Help.yml).github/workflows/Deploy MkDocs.yml)Documentation Configuration:
.readthedocs.yaml)New Scripts:
Build/MarkdownRepair.ps1)Build/Write-HelpOutDocs.ps1)Build/Write-PlatyPSDocs.ps1)Documentation Updates:
Invoke-Locksmithcmdlet, including its synopsis, syntax, description, examples, parameters, inputs, outputs, notes, and related links. (Docs/Invoke-Locksmith.md)