Bring the docs in line with 3.4.0 - #20
Merged
Merged
Conversation
Two documented things did not exist. The architecture doc told users to restore with reg import from %TEMP%\WinSwift_Backup_<timestamp>.reg, but backups are JSON under Backups\WinSwift-RegistryBackup-<timestamp>.json. It also documented a -Revert parameter that has never been declared, and the README and upstream matrix both advertised it. Replaced with what the code does: the automatic rollback path, the manual restore through Load-RegistryBackupFromFile and Restore-RegistryBackupState, and -Undo for individual features. Also documents the rollback stage in the README, which had a section titled "Rollback Architecture" describing only backup and verification, adds the exit code table covering 3 and 4, updates the flow diagram to show the failure branch, and records -Undo and -NoAutoRollback. SECURITY.md moves the supported line to 3.4.x and marks 3.3.x unsupported, noting the elevation guard that printed its warning and then continued into the apply pipeline.
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.
Two documented things did not exist.
docs/Execution-Architecture.mdtold users to restore with:Backups are JSON, written to
Backups\WinSwift-RegistryBackup-<timestamp>.json. Nothing in the codebase has ever written to that%TEMP%path. The same doc, the README comparison table, and the UPSTREAM capability matrix all advertised a-Revertparameter that has never been declared inWinSwift.ps1.Replaced with what the code actually does: automatic rollback, manual restore through
Load-RegistryBackupFromFile+Restore-RegistryBackupState, and-Undofor individual features.Other corrections:
-SkipRegistryBackupinteraction.3(rolled back) and4(rollback failed). Both were undocumented outside the changelog.-Undoand-NoAutoRollbackdocumented in the README and wiki.-Undo.3.4.x, marks3.3.xunsupported with the reason, and adds sections for elevation enforcement and automatic rollback.Docs only. Static validation passes (110 files).