Context and request
README.md is still the unmodified Template-PSModule scaffold: {{ NAME }}, {{ DESCRIPTION }}, Greet-Entity -Name 'World', Import-Module -Name PSModuleTemplate, and Get-Help -Examples 'CommandName'. It documents a module that does not exist and never mentions Format-Json, Import-Json, or Export-Json. Because the README is published as the module's landing page at psmodule.io/Json, this is the first thing a prospective user sees.
examples/General.ps1 is written against POSIX paths (/tmp/config.json, /tmp/user-*.json) and cannot run on Windows, even though the module is tested on a three-OS matrix.
Scope
In scope: README.md and examples/General.ps1.
Out of scope: comment-based help content, which is a function-contract concern, and the documentation site configuration.
Aggregate acceptance criteria
- Every check in README validation returns no matches.
- The README answers the five start-page questions in order and includes a capabilities showcase before the documentation link.
- Every command and snippet shown in the README and examples runs as written against the published module.
examples/General.ps1 runs to completion on Linux, macOS, and Windows.
Technical decisions
The README follows the implemented-module shape from the Repository Standard rather than the placeholder shape, because Json has three working commands. Installation uses Install-PSResource; Install-Module is not acceptable in new module documentation.
The community-file index section in the current README is removed rather than corrected. The standard is explicit that a README should not act as a link farm for LICENSE, CONTRIBUTING.md, SECURITY.md, and CODE_OF_CONDUCT.md, since GitHub already surfaces them.
Nothing unique is being deleted: the current README contains no prerequisites, authentication, or operational content that needs relocating, because it has never been customized.
Examples use [System.IO.Path]::GetTempPath() rather than a hardcoded /tmp.
PR #22 already addresses the README half and should be reconciled into this work rather than duplicated.
Implementation plan
Delivery is tracked through the native sub-issues on this PBI.
Context and request
README.mdis still the unmodifiedTemplate-PSModulescaffold:{{ NAME }},{{ DESCRIPTION }},Greet-Entity -Name 'World',Import-Module -Name PSModuleTemplate, andGet-Help -Examples 'CommandName'. It documents a module that does not exist and never mentionsFormat-Json,Import-Json, orExport-Json. Because the README is published as the module's landing page at psmodule.io/Json, this is the first thing a prospective user sees.examples/General.ps1is written against POSIX paths (/tmp/config.json,/tmp/user-*.json) and cannot run on Windows, even though the module is tested on a three-OS matrix.Scope
In scope:
README.mdandexamples/General.ps1.Out of scope: comment-based help content, which is a function-contract concern, and the documentation site configuration.
Aggregate acceptance criteria
examples/General.ps1runs to completion on Linux, macOS, and Windows.Technical decisions
The README follows the implemented-module shape from the Repository Standard rather than the placeholder shape, because
Jsonhas three working commands. Installation usesInstall-PSResource;Install-Moduleis not acceptable in new module documentation.The community-file index section in the current README is removed rather than corrected. The standard is explicit that a README should not act as a link farm for
LICENSE,CONTRIBUTING.md,SECURITY.md, andCODE_OF_CONDUCT.md, since GitHub already surfaces them.Nothing unique is being deleted: the current README contains no prerequisites, authentication, or operational content that needs relocating, because it has never been customized.
Examples use
[System.IO.Path]::GetTempPath()rather than a hardcoded/tmp.PR #22 already addresses the README half and should be reconciled into this work rather than duplicated.
Implementation plan
Delivery is tracked through the native sub-issues on this PBI.