Repository navigation
Entry pages and workflow examples use direct prose - #579
Open
Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
Open
Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
Marius Storhaug (MariusStorhaug) wants to merge 5 commits into
Conversation
8 tasks done
Contributor
There was a problem hiding this comment.
🟢 Approved
No active review issues are recorded for this documentation-only update.
No open issues 🎉
What changed in this PR
This documentation-only PR makes entry pages and workflow guidance more direct and evergreen, addressing the released prose scope of #560 without changing pipeline behavior or consumer requirements.
Changes:
- Clarifies the framework description while retaining all five lifecycle capabilities and the PowerShell Gallery destination.
- Replaces promotional and time-dependent wording with direct descriptions.
- Uses en-US spelling and present-tense wording for the unchanged 80% coverage example.
| File | Description |
|---|---|
README.md |
Describes the core workflow directly, preserving its scope and capabilities. |
docs/content/index.md |
Simplifies framework prose and guidance wording while retaining headings and link targets. |
docs/content/guides/versioning-and-releases.md |
Changes “labelled” to “labeled” without altering release guidance. |
docs/content/guides/configuring-the-pipeline.md |
States the 80% coverage requirement in present tense; YAML remains unchanged. |
Review effort: Balanced
Super-linter summary
All files and directories linted successfully For more information, see the GitHub Actions workflow run Powered by Super-linter |
Marius Storhaug (MariusStorhaug)
dismissed
Copilot’s stale review
via
November 4, 2026 13:55
79bac09
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.
Entry pages describe the framework's reusable PowerShell modules, GitHub Actions workflows, and task automation in direct, present-tense English. The coverage example states its existing minimum of 80%, and the changed descriptive text uses en-US spelling. No consumer action is needed for these prose edits.
Changed: Entry guidance describes existing automation directly
The README and site index use direct descriptions instead of promotional or time-relative wording. The coverage example says
at least 80%because the existing implementation rejects coverage only when it is below the target. The release guide changes only two descriptive uses oflabelledtolabeled.The edits preserve the documented capabilities, supported scope, destinations, examples, and obligations. They do not change the framework, caller interface, configuration, release behavior, or site design. The complete fixed-secret/TestData adoption section stays intact. Its separate source-bound decision remains open in #578.
Technical details
Exact delivery source and plan
PSModule/Process-PSModulemainat64ffb1d87f86bd5d487891fdb140b78385a00531entry-guidance-proseat79bac09b581e80b27bae5dad5d87adffac0ff21993b95eb6935d43c3e350bcdd293e19c128dc7aa3; this draft opened immediately after that pushThis is a fresh main-based delivery, not an amendment to a proposal or first-pass PR. The owner handback includes the explicit extension for the two adjacent index statements at original lines 80-81. No other paragraph-rewrite permission is inferred from the spelling allowance.
The issue plan covers the full ten-page read, pinned writing sources, pre-edit expectations, protection baselines, existing checks, early draft, small commits, live ownership checks before each commit, the source-backed threshold clarification, and the final acceptance record. All scoped implementation and verification work is complete. Merge and issue closure remain separate, future review actions.
Before/after acceptance evidence
The original pre-edit record records the source, expected edits, protection baseline, and existing checks before repository changes. The threshold clarification record records the parent review request and the below/equal/above experiment before that follow-up edit. All eight exact replacement expectations pass at the final head. They cover nine matches, including the two release-spelling matches.
corner-stoneparagraphbehaviourbehavior; the rest of the paragraph and.github/PSModule.ymlremain unchanged.infuses GitHub ... fullest extentandDevOps functionality ... missingWe empower ... effortlessly ... without distractionsWhere we are headed ...are now canonicalare canonical; authority and destination remain unchanged.will require that code coverage is 80% before passingThis example runs all steps and requires at least 80% code coverage to pass.The exact YAML is unchanged.labelledtwicelabeledtwice; all other release guidance is identical.The complete changed-file comparison permits only these declared replacements. All other text in those four files remains unchanged, including the index introduction, the development-framework heading/anchor, and every configuration/release example.
Ten-page review and no-change results
All ten pages were read in full. The four changed paths and exact regions are listed above. The other six pages need no correction under the narrow spelling allowance. Their complete file bytes and Git blobs remain unchanged. This is a scoped no-change result, not a claim that every paragraph received an unrestricted rewrite or full STE certification.
docs/content/get-started/index.md72cc182b8e790c4b5420277d69a61de934a02791docs/content/get-started/repository-setup.md790cf5eafb2946cad7c61398e7f80c7fcf6cc8a5docs/content/get-started/your-first-release.mde8b00fb1c220108790517d151dc59b707d895928docs/content/guides/calling-the-workflow.md8e18d7e18025b68a1abd318c115719607d3683c3docs/content/guides/github-app-authentication.mdcf35933a019eaf977a8ce39ad940ab809edfe9b5docs/content/guides/structuring-your-module.mdc4f36cf327b9e5f045a02b7d05bbb54e7bb39334README.mdc2d2257e3948184ebb8db36268f1c7490e0abcbc924672d74ec5927a3bc4b0591b0311cbd9f4e038docs/content/index.md02cc155fc51c96deba28eaf9ae1f9e899baf2d9703a57bba4e97779ec2e35b9764f024fcb37ba454docs/content/guides/configuring-the-pipeline.mdb77d4cdf2272ad592234076eec0a48afd692a926ae643ebc87483b2154091fa98a681be35416ae40docs/content/guides/versioning-and-releases.mdfe226002f077d1e0e7a01a01514d8112b33033177694d507ba5f6b0f1d47bb9f2cf04e23d68a9578Exact contract-preservation results
The session-local, one-off comparison passes against the source tree. No comparison script, prose inventory, enforcement tool, test, or dependency is added to the repository.
The protected fixed-secret/TestData section, lines 76-104, including its heading, all seven old input names, mapping instructions, and complete adoption example, is byte-identical. Its source-LF region is 1,045 bytes with SHA-256
96ac1034b74d2c76c8fc770d3f21a196b3d7cfd685210974d0a90d63bc61f54aat both base and head. The existing CRLF worktree region is 1,074 bytes with SHA-2562a90ca000acc18720d4f281a8fb42e8b92206e9e968f9e70fc8dc3c39b37b05fbefore and after. The entire calling-guide blob is unchanged.The coverage text retains this exact sample:
The settings reference still defines the separate default as
0. The existing workflow mapping forwards that setting. The existing implementation accepts coverage greater than or equal to its target and fails only below target. The pre-edit experiment executes those extracted comparisons with target 80: 79.99 fails, 80 passes, and 80.01 passes.At least 80%clarifies this existing boundary; it does not change policy or behavior.The built-site comparison passes 12 explicit checks. It confirms the new prose, both reader roles, the existing development-framework anchor, the goal-setting and canonical-guidance destinations, both
labeledsentences, the migration heading and all seven old input names, and the exact decoded coverage YAML. Code text is read without inserting whitespace between syntax-highlight spans.Existing checks and outcomes
The existing Markdown configuration passes on all ten pages before and after the edits: markdownlint-cli2 0.24.0, markdownlint 0.42.0, 10 files, 0 issues. The existing codespell 2.4.2 CLI passes with the repository configuration. The existing Zensical 0.0.50 build passes before and after, reporting
No issues found. The exact base-to-head whitespace check passes.These commands use the same ten-file set as the recorded runs:
No standalone link-check command exists in this repository. The existing site build reports no issues; separate exact link/heading comparisons and rendered destination checks confirm no link regression from these edits. This is not a new internet-wide link-validation claim. An initial
python -m codespellinvocation used the wrong entry point; the existingcodespellCLI passes. No repository dependency is changed.Hosted snapshot at
2026-11-04T13:59:39Z, for head79bac09b581e80b27bae5dad5d87adffac0ff219:No hosted check or review remains pending at this snapshot. Earlier-head approval is not used as final-head evidence. The parent current-head content review also accepts
79bac09b581e80b27bae5dad5d87adffac0ff219after independently checking the complete four-file diff and the protected structures across all ten pages. This content acceptance does not change draft or merge state.Standards, ownership, and scope alignment
The fixed writing source is MSXOrg/docs at
1b0d4893c8fefabe604d04393068a8ff6f848082. The review covers Documentation Model; Natural Language; Writing Guide; Markdown; Documentation; the guide/reference templates; and the Task, PR, workflow, and commit formats. The official STE overview, FAQ, and relevant Issue 9 rules/dictionary were consulted through the verified local manual. No manual material is republished. These edits apply STE writing practices; scans, counts, and lint do not establish full STE conformance.The source, issue scope, live owner heads, and intersecting paths are rechecked before each of the five commits and at final handoff. The source remains
64ffb1d87f86bd5d487891fdb140b78385a00531. Active owner heads are unchanged:0fb4234056b3bd4574c58cd4edd6dff2544d70f603e24f359265b7a4106f8f71f769cba1ba12bf3c50f16425797ec67375d47262c8c79d3507fb2b217204e1eb418f99848c396f7e3597152a70e362ffaf22c475873b21b8afa5ba7ecb87cb2bf8efabd2eb3eb0cb8fb6f0b7822c79ad9b2781d17127dcd4663d87b9c11e7d5662a986f662e4f7499e816f557a00cbb9cd72baddf14d990019cf5da3c9c3600e; no intersection with the ten-page set#565 through #570 retain disjoint paths and unchanged heads. No existing owner branch is awakened or edited. No new caller, release, compatibility, shipping, or enforcement contract is imported from a proposal.
The issue-convergence search covers the open
documentation-writing-alignmentissues and the active owners intersecting this ten-page set. This diff resolves only #560. It does not resolve the reserved interface, source-contract, or TestData adoption work. No additional closing reference is added.No scoped wording decision remains. #578 retains the actual baseline/target, source-bound release-record, compatibility, and exact #535 / #537 owner decisions. This PR makes none of those decisions.
The PR remains draft. No merge, ready transition, auto-merge, Agent merge, release-label, or publication action is performed.
Related references