Repository navigation
Glossary definitions use direct evergreen prose - #567
Open
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
Open
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
Marius Storhaug (MariusStorhaug) wants to merge 4 commits into
Conversation
8 tasks done
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Contributor
There was a problem hiding this comment.
🟢 Approved
No active review issues remain for these glossary wording and definition updates.
No open issues 🎉
What changed in this PR
This documentation-only PR makes the PSModule glossary more direct and evergreen. It preserves page paths, navigation targets, and contribution and search procedures without changing workflow, module, or configuration behavior.
Changes:
- Rewrites glossary definitions and examples as concise, direct statements.
- Clarifies technical concepts, including APIs, CI/CD, Git branches, and PowerShell LTS.
- Updates abbreviation descriptions and simplifies index guidance.
| File | Description |
|---|---|
docs/includes/abbreviations.md |
Refines CI/CD, Docker, HTML, pwsh, and XML descriptions. |
docs/content/Dictionary/yaml.md |
Simplifies the YAML definition and workflow example. |
docs/content/Dictionary/workflow.md |
Uses direct wording for automated workflows. |
docs/content/Dictionary/template.md |
Shortens the template definition. |
docs/content/Dictionary/semantic-versioning.md |
Explains version format and change significance. |
docs/content/Dictionary/rest-api.md |
Distinguishes REST interfaces from HTTP resource operations. |
docs/content/Dictionary/pull-request.md |
States the proposal and review purpose directly. |
docs/content/Dictionary/powershell.md |
Separates the framework definition from its components. |
docs/content/Dictionary/pipeline.md |
Removes subjective claims from the pipeline definition. |
docs/content/Dictionary/mkdocs.md |
Describes documentation generation without promotional wording. |
docs/content/Dictionary/markdown.md |
Clarifies syntax and document conversion. |
docs/content/Dictionary/lts.md |
Adds the .NET LTS relationship and clarifies lifecycle guidance. |
docs/content/Dictionary/index.md |
Simplifies reference, contribution, and search guidance. |
docs/content/Dictionary/github.md |
Condenses the platform definition. |
docs/content/Dictionary/github-actions.md |
Clarifies automation tasks and the pull request example. |
docs/content/Dictionary/docker.md |
Describes container tooling in direct terms. |
docs/content/Dictionary/cmdlet.md |
Simplifies the task and naming description. |
docs/content/Dictionary/ci-cd.md |
Distinguishes integration, delivery, and deployment. |
docs/content/Dictionary/branch.md |
Defines branches as development lines and Git commit pointers. |
docs/content/Dictionary/azure-functions.md |
Clarifies event-driven execution and serverless hosting. |
docs/content/Dictionary/api.md |
Replaces the GUI-specific claim with a communication definition. |
Review effort: Balanced
Marius Storhaug (MariusStorhaug)
marked this pull request as ready for review
November 4, 2026 14:43
This branch has not been deployed
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 glossary explains PSModule terms with direct en-US statements. The definitions distinguish integration, delivery, deployment, and REST interfaces. Abbreviation tooltips use consistent technical names. Contribution and search procedures remain direct instructions.
No consumer action is required. Page paths, heading anchors, front matter, abbreviation keys, versions, and example operations stay unchanged. This pull request changes guidance only; it does not change module, workflow, configuration, or site-generator behavior.
Changed: Glossary definitions state their meaning directly
The index states its reference purpose without a greeting or rhetorical question. Definitions use short descriptions with named subjects and active verbs. The API entry describes software communication without an unexplained GUI-specific use claim. CI/CD includes both meanings of CD, and the REST API entry distinguishes an interface from the REST architectural style.
The abbreviation include keeps all 50 keys in their original order. Five tooltip values change; the other 45 values stay byte-for-byte unchanged. The glossary retains MkDocs as a term without claiming that it builds this documentation site. It also retains Microsoft's exact Long-Term Servicing name and the existing PowerShell 7.5 support link.
Technical details
Source and comparison identities
PSModule/Process-PSModule.64ffb1d87f86bd5d487891fdb140b78385a00531.e0dd865ff0973a0eef3b3a75a0fac81ff1541592.docs\includes\abbreviations.md; 48 insertions and 40 deletions.5f9d0d6e69fd52b838228a99ffaa8420ede63f9e,88b9f46ab0d7ea8739db243ab1f374795c19b944,1d1db67f2956d035a36b140994d84cf1f625a105, ande0dd865ff0973a0eef3b3a75a0fac81ff1541592.The draft opened after the first coherent commit. This is a scoped documentation record, not a versioned-artifact release record. The documentation route in
.github\workflows\Docs.ymlruns lint and a site build for pull requests. No release decision block orrelease:*label is added.Pinned writing baseline
The review uses MSXOrg/docs commit
1b0d4893c8fefabe604d04393068a8ff6f848082, not movingmain:The official STE overview, FAQ, and ASD-STE100 Issue 9 were available. The local PDF MD5,
9c720341c350ed77943b2c73d01c716f, matches the official record.Manual review covers technical nouns, en-US spelling, present-tense descriptions, active voice, short complete sentences, logical order, and direct instructions. Applicable rule references are 1.1-1.14, 3.2, 3.5-3.6, 4.1-4.2, and 6.1-6.6. Technical names, including
YAML Ain't Markup Language, retain their exact form. No manual text or extraction is republished. This review does not claim full STE conformance. Lint, rendering checks, and counts verify specific properties; they do not prove language conformance.Full changed-path inventory and before/after evidence
All 32 Dictionary files and the abbreviation include received a full manual read before edits. The issue records original text and expected properties before implementation. This table lists every changed path.
docs\content\Dictionary\api.mddocs\content\Dictionary\azure-functions.mddocs\content\Dictionary\branch.mddocs\content\Dictionary\ci-cd.mddocs\content\Dictionary\cmdlet.mdGet-Process,Set-Location, andNew-Itemare unchanged.docs\content\Dictionary\docker.mddocs\content\Dictionary\github-actions.mddocs\content\Dictionary\github.mddocs\content\Dictionary\index.mddocs\content\Dictionary\lts.mdview=powershell-7.5URL are unchanged.docs\content\Dictionary\markdown.mddocs\content\Dictionary\mkdocs.mddocs\content\Dictionary\pipeline.mddocs\content\Dictionary\powershell.mddocs\content\Dictionary\pull-request.mddocs\content\Dictionary\rest-api.mdGET,PUT,POST, andDELETEnames remain as HTTP method examples.docs\content\Dictionary\semantic-versioning.mdMAJOR.MINOR.PATCH. The version number indicates whether a change affects compatibility, adds functionality, or fixes a bug." The1.2.3example is unchanged.docs\content\Dictionary\template.mddocs\content\Dictionary\workflow.mddocs\content\Dictionary\yaml.mddocs\includes\abbreviations.mdExact tooltip changes
CI/CDDockerHTMLpwshXMLFull reviewed no-change inventory
These 12 assigned pages received a full manual review and remain byte-for-byte identical to the base. The short lookup definitions already identify their concepts without change history or conversational introductions. The review does not manufacture changes merely to rewrite every definition.
docs\content\Dictionary\azure.mddocs\content\Dictionary\azure-devops.mddocs\content\Dictionary\build-pipeline.mddocs\content\Dictionary\container.mddocs\content\Dictionary\devops.mdDevandOpsremain exact terms.docs\content\Dictionary\git.mddocs\content\Dictionary\module.mddocs\content\Dictionary\repository.mddocs\content\Dictionary\static-site-generator.mddocs\content\Dictionary\testing.mddocs\content\Dictionary\version-control.mddocs\content\Dictionary\virtual-environment.mdThe other 45 abbreviation values also have a no-change result. They are short technical-name expansions or lookup phrases. Their exact original bytes are retained. The renderer verifies every key and value, including these no-change entries.
Excluded paths and compatibility
No assigned file is excluded from review. The two inventories above account for all 33 assigned files. Every other repository path is excluded from edits. This includes
README.md,AGENTS.md,docs\zensical.toml,docs\content\index.mdand its generated index region,docs\content\Modules\**, otherdocs\contentsections, other includes,.github\**, tests, native help, source code, and dependency manifests. Existing framework and release proposals keep their own paths.All 31 front-matter blocks across 32 pages, all page paths, all source link-target sequences, and all rendered heading anchors are unchanged.
Dictionary\index.mdhas no YAML front matter. Only the case of the index's Table of contents and Quick reference headings changes; their anchors are stilltable-of-contentsandquick-reference. No link repair is required. Cmdlet examples, the semantic-version example1.2.3, the PowerShell 7 tooltip version, and the existing PowerShell 7.5 URL stay intact. Contribution and search instructions remain imperative. No requirement or normative keyword is strengthened or weakened.Open PR file ownership was rechecked before each of the four commits. No other open PR owns an assigned path.
Validation commands and results
The existing repository tools were already available. No tool or repository dependency was installed. Versions: Python
3.14.10, Zensical0.0.50, Markdown3.10.2, markdownlint-cli20.24.0, and markdownlint0.42.0.The Windows lint command enumerates actual files instead of relying on wildcard expansion:
Result: 33 files, 0 issues, before edits and after each coherent change. The first wildcard probe covered only the include; it was rejected as glossary evidence and replaced with the explicit 33-file command.
The existing site check runs in complete local copies of
docsunder session artifacts, so its cache and generated output do not modify an excluded repository path:Result: "No issues found" for both commands on both the unchanged base and the final committed documentation. The command matches
.github\workflows\Docs.yml; strict mode adds the builder's warning gate.git diff --check 64ffb1d87f86bd5d487891fdb140b78385a00531..HEADHTMLParserinspection of the existing site outputmarkdown.markdownrenderer with the project'sabbrandpymdownx.snippetssettingsInvoke-WebRequest -Method Headfor the two authored external content URLsgit status --porcelain=v1No Pester or runtime test suite is needed for this prose-only diff. The documentation build and Markdown checks cover the changed surface without adding an enforcement script.
The documentation CI run completes successfully at the exact final head. Build, Lint, Markdown, natural-language, and spelling checks pass. The repository linter also passes. All reported PR checks are successful except the expected Publish skip on a pull request.
Standards and framework alignment
docs\content\Dictionary\*.mddocs\includes\abbreviations.mdabbrand snippet configuration indocs\zensical.toml; canonical terminology sources aboveThe delivery issue carries the test-first examples and plan progress. The scope check searched open issues for
glossary,abbreviation, andDictionary. Other documentation leaves, #556, #557, and #559, retain their separate paths. #509 concerns migrated links; the base already passes the strict build with the installed builder, so this diff does not claim to resolve that issue. Only the assigned delivery leaf has a closing reference.The pull request remains draft and is assigned to its author. Copilot review was explicitly requested with
gh pr edit 567 --repo PSModule/Process-PSModule --add-reviewer '@copilot'. No merge, ready-for-review transition, auto-merge, or Agent merge is requested.Final review and CI status: Copilot approves head
e0dd865ff0973a0eef3b3a75a0fac81ff1541592in review5768355755, submitted at2026-11-04T12:36:44Z, with no inline comments or active review issues. CI passes. The draft state is intentional. No implementation blocker, unavailable source, or path conflict remains. Human review and any later readiness or merge decision remain outside this delivery.Related references