Skip to content

⚙️ [Maintenance]: Remove instruction files colocated into the docs site#349

Draft
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
mainfrom
maintenance/remove-colocated-instructions
Draft

⚙️ [Maintenance]: Remove instruction files colocated into the docs site#349
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
mainfrom
maintenance/remove-colocated-instructions

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Jun 1, 2026

Copy link
Copy Markdown
Member

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.md and .github/instructions/pwsh.instructions.md files (and the now-empty instructions folder) have been removed. The same guidance is published — and expanded with a new GitHub Actions guide — at the docs site:

  • Companion PR: PSModule/docs#43 adds the Style Guides section.

This is an internal maintenance change. It does not affect the shipped artifact or any workflow behavior.

Technical Details

  • Deleted .github/instructions/md.instructions.md and .github/instructions/pwsh.instructions.md.
  • Content migrated verbatim to src/docs/Style-Guides/Markdown.md and src/docs/Style-Guides/PowerShell.md in PSModule/docs.

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant