📖 [Docs]: Coding style guides now live in the docs site#43
Draft
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
Draft
📖 [Docs]: Coding style guides now live in the docs site#43Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
Marius Storhaug (MariusStorhaug) wants to merge 1 commit into
Conversation
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.
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:
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-PSModulerepository; the GitHub Actions guide is new and aligns with the existing GitHub Actions Standard.Technical Details
src/docs/Style-Guides/withindex.md,GitHub-Actions.md,Markdown.md, andPowerShell.md.applyTo) was replaced with docs frontmatter (title/description).Style Guidessection in thenavarray insrc/zensical.toml, placed between GitHub Actions and Solutions.PSModule/Process-PSModule#349removes the now-migrated instruction files.