Contributors and agents use the MSX documentation as one canonical instruction set, but several pages on the live default branch currently disagree. Following one page can therefore violate another:
PR-Format.md requires the related-issues block at the end, while Repository-Standard.md places issue links before user-facing change sections.
Branching-and-Merging.md requires <type>/<issue>-<slug> branch names, while Git-Worktrees.md says the branch name matches a <issue>-<slug> folder.
Issue-Format.md says implementation-plan tasks put tests last, while the testing standard defines test-first development.
- The framework-test skip example uses
return, omits complete help and output metadata, and leaves a parameter untyped even though it demonstrates a PowerShell function.
Request
Make these pages internally consistent so a reader can follow the repository, workflow, testing, and PowerShell standards together without choosing between contradictory instructions.
Acceptance criteria
- The repository-standard PR description order matches the canonical PR format, including the final related-issues block
- Worktree folder naming is distinguished from the required branch naming convention
- Implementation-plan ordering does not imply that tests are implemented after behavior
- The framework-test skip example follows the PowerShell function standard except for the one rule it intentionally demonstrates skipping
- Existing links, generated indexes, linting, and the documentation build remain valid
Technical decisions
Canonical precedence: Specialized pages remain authoritative. PR-Format.md, Branching-and-Merging.md, Testing.md, and PowerShell/Functions.md define their respective rules; summary and example pages align to them.
Worktree naming: Keep the concise <issue>-<slug> folder example, but use the standard <type>/<issue>-<slug> branch name and state explicitly that the folder and branch do not need identical names.
Test planning: Organize implementation plans by dependency and place each behavior's tests with that behavior. Preserve test-first execution rather than using a blanket “tests last” rule.
Skip example: Keep multiple functions because the example intentionally skips FunctionCount; make every shown function otherwise compliant and state that only the named framework rule is exempted.
Validation: Run the documentation index check, link validator, clean Zensical build, and repository CI.
Implementation plan
Workflow consistency
PowerShell example
Validation
Contributors and agents use the MSX documentation as one canonical instruction set, but several pages on the live default branch currently disagree. Following one page can therefore violate another:
PR-Format.mdrequires the related-issues block at the end, whileRepository-Standard.mdplaces issue links before user-facing change sections.Branching-and-Merging.mdrequires<type>/<issue>-<slug>branch names, whileGit-Worktrees.mdsays the branch name matches a<issue>-<slug>folder.Issue-Format.mdsays implementation-plan tasks put tests last, while the testing standard defines test-first development.return, omits complete help and output metadata, and leaves a parameter untyped even though it demonstrates a PowerShell function.Request
Make these pages internally consistent so a reader can follow the repository, workflow, testing, and PowerShell standards together without choosing between contradictory instructions.
Acceptance criteria
Technical decisions
Canonical precedence: Specialized pages remain authoritative.
PR-Format.md,Branching-and-Merging.md,Testing.md, andPowerShell/Functions.mddefine their respective rules; summary and example pages align to them.Worktree naming: Keep the concise
<issue>-<slug>folder example, but use the standard<type>/<issue>-<slug>branch name and state explicitly that the folder and branch do not need identical names.Test planning: Organize implementation plans by dependency and place each behavior's tests with that behavior. Preserve test-first execution rather than using a blanket “tests last” rule.
Skip example: Keep multiple functions because the example intentionally skips
FunctionCount; make every shown function otherwise compliant and state that only the named framework rule is exempted.Validation: Run the documentation index check, link validator, clean Zensical build, and repository CI.
Implementation plan
Workflow consistency
src/docs/Ways-of-Working/Repository-Standard.mdsrc/docs/Ways-of-Working/Git-Worktrees.mdsrc/docs/Ways-of-Working/Issue-Format.mdPowerShell example
src/docs/Frameworks/Process-PSModule/skipping-framework-tests.md.LINKentries to the generatedpsmodule.iopublic function page and document the canonical URL patternValidation