Repository navigation
docs(readme): keep the overview free of release history - #50
Merged
Merged
Conversation
Nineteen section headings ended in the version that introduced the feature, the tenant pre-flight paragraph said since when each check existed, and the roadmap listed thirteen features by version. A first visitor wants the overview; the history is in CHANGELOG.md, which the roadmap now points at. The changelog's preamble no longer links to the private repository the module was first developed in.
fadwen
commented
Oct 19, 2026
fadwen
left a comment
fadwen
left a comment
Owner
Author
There was a problem hiding this comment.
Notes on the lines whose reason the diff does not show.
| (0.13), SARIF (0.14), Repair-IntuneScript (0.15), filters (0.17), another account (0.18), the | ||
| Enrollment Status Page (0.19), drift (0.20), assignment sanity (0.21), the health report (0.22), | ||
| timelines and the diagnostic zip (0.23). See [CHANGELOG.md](CHANGELOG.md). | ||
| has shipped; [CHANGELOG.md](CHANGELOG.md) says what arrived when. |
Owner
Author
There was a problem hiding this comment.
The roadmap keeps its one bullet, 1.0, because that is the only forward-looking statement the README makes; the thirteen shipped items were history dressed as a plan, and the changelog carries them with dates.
| [powershell_scripts](https://github.com/fadwen/powershell_scripts) repository, where the module | ||
| lived under `Scripts/Intune/IntuneScriptLab`. Their entries are carried over from the manifest's | ||
| release notes. | ||
| Versions before 0.25.0 were released from a private repository where the module began; their |
Owner
Author
There was a problem hiding this comment.
The sentence stays so the version numbers below 0.25.0 have an explanation, since their entries have no commits in this repository to point at; only the link and the path went, because a visitor cannot open the private repository and the path inside it tells them nothing.
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
1 participant
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.
Summary
The README is the overview a first-time visitor reads, and it carried the module's release history in its margins: nineteen section headings ended in the version that introduced the feature, such as "Suppressions and settings (0.13)", the tenant pre-flight paragraph said since when each check existed, and the roadmap listed thirteen features by version. None of that helps someone deciding whether the module does what they need, and all of it is in
CHANGELOG.md. The changelog's own preamble linked to the private repository the module was first developed in, which a visitor cannot open.Changes
README.md: the "(0.x)" suffix is gone from every heading; "since 0.17" and "Since 0.21" are gone from the tenant pre-flight paragraph; the roadmap bullet says everything on the original list has shipped and points at the changelog for when.CHANGELOG.md: the preamble says versions before 0.25.0 came from a private repository, without the link or the path; a Changed entry under Unreleased records the cleanup.Verification
(0.x)heading suffix or "since 0.x" phrase remains inREADME.md; the Markdown structure (headings, lists, tables, code fences) is unchanged apart from the removed suffixes and the shorter roadmap bullet.Build/Publish-Module.ps1ships the README as is, and the one test that mentions the README cites it in a comment.