fix: use full semver in release notes filenames#10855
Conversation
Rename 17 release notes files from release-1.X.md to release-1.X.0.md to use explicit semantic versioning. This helps AI coding agents identify the correct version-specific documentation when upgrading SPFx projects. Changes: - Renamed 17 files (1.1, 1.3-1.7, 1.13-1.23) - Updated version references within each renamed file - Updated TOC entries (name + href) - Added 17 redirect entries for old URLs - Updated 2 existing redirect targets - Updated ~40 cross-references across 22 files
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
|
Learn Build status updates of commit b762d3d:
|
Summary
Renames 17 SPFx release notes files from
release-1.X.mdtorelease-1.X.0.mdto use explicit semantic versioning (e.g.,release-1.22.md→release-1.22.0.md).Why
AI coding agents that help developers upgrade SPFx projects rely on release notes filenames to locate version-specific documentation. When a file is named
release-1.22.mdrather thanrelease-1.22.0.md, agents don't recognise it as the1.22.0release and skip it — even though it contains the exact information they need.In benchmark testing, agents failed to fetch the correct release notes in 4 out of 5 runs. After simulating the semver filename change, agents fetched the right docs in 5 out of 5 runs.
Changes
release-1.X.md→release-1.X.0.md(versions: 1.1, 1.3–1.7, 1.13–1.23)docs/toc.ymlname and href entries updated.openpublishing.redirection.jsonfor old URLsrelease-1.14)No breaking changes
release-1.22.1.md,release-1.17.4.md) are untouched