⚙️ [Maintenance]: Remove instruction files colocated into the docs site#349
Draft
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
Draft
⚙️ [Maintenance]: Remove instruction files colocated into the docs site#349Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
Conversation
Marius Storhaug (MariusStorhaug)
added a commit
to PSModule/docs
that referenced
this pull request
Jul 2, 2026
The PSModule coding style guides now live in the documentation site under a new **Style Guides** menu section. Contributors and agents can browse the GitHub Actions, Markdown, and PowerShell conventions directly on the docs site instead of digging through editor instruction files in another repository. ## New: Style Guides section in the docs A new **Style Guides** entry appears in the top navigation, containing: - **GitHub Actions** — workflow and composite action authoring conventions: job/step naming, quoting, SHA pinning, minimal permissions, OIDC and secrets handling, untrusted-input safety, trigger isolation, runner pinning, and a zizmor security checklist. - **Markdown** — headings, lists, code blocks, links, tables, emphasis, whitespace, and filename conventions. - **PowerShell** — One True Brace Style, naming, parameters, error handling, pipeline design, performance, and Pester testing conventions. Each guide states the rule, shows good and bad examples, and explains how to apply it. The Markdown and PowerShell guides are migrated verbatim from the editor instruction files that previously lived in the `Process-PSModule` repository; the GitHub Actions guide is new and aligns with the existing GitHub Actions Standard. ## Technical Details - Added `src/docs/Style-Guides/` with `index.md`, `GitHub-Actions.md`, `Markdown.md`, and `PowerShell.md`. - Editor-specific frontmatter (`applyTo`) was replaced with docs frontmatter (`title`/`description`). - Registered the new `Style Guides` section in the `nav` array in `src/zensical.toml`, placed between **GitHub Actions** and **Solutions**. - Companion PR: `PSModule/Process-PSModule#349` removes the now-migrated instruction files. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
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
1 participant
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.
The Markdown and PowerShell style instruction files have been removed from this repository. Their content now lives in the PSModule documentation site under the new Style Guides section, giving contributors and agents a single, browsable source of truth for coding conventions.
Changed: Instruction files moved to the docs site
The
.github/instructions/md.instructions.mdand.github/instructions/pwsh.instructions.mdfiles (and the now-emptyinstructionsfolder) have been removed. The same guidance is published — and expanded with a new GitHub Actions guide — at the docs site:PSModule/docs#43adds the Style Guides section.This is an internal maintenance change. It does not affect the shipped artifact or any workflow behavior.
Technical Details
.github/instructions/md.instructions.mdand.github/instructions/pwsh.instructions.md.src/docs/Style-Guides/Markdown.mdandsrc/docs/Style-Guides/PowerShell.mdinPSModule/docs.