docs: explain cleanup when updating existing machines - #38
Merged
Conversation
Document that removed source declarations can leave old files and shared configuration fields on existing machines. Require retirement commits to identify the affected non-secret targets or fields, explain their removal, and state which local content to preserve. Keep the existing policy without a historical deletion list while giving other Macs and downstream forks the information needed for cleanup.
Keep per-machine cleanup steps in the READMEs and explain source deletion behavior and the cost of avoiding deletion history under configuration ownership. Keep the retirement commit requirements in the contributor workflow so downstream users can find cleanup details in the history.
liby
force-pushed
the
bugfix/34-document-upgrade-cleanup
branch
from
September 10, 2026 18:53
52fb4cf to
a21ea06
Compare
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.
Existing machines can retain files and shared configuration fields after their source declarations are removed. The READMEs tell users to review retirement commits and inspect local contents before cleanup; AGENTS.md requires those commits to identify affected paths or fields, the removal reason, and content to preserve.
CONCEPTS.md owns the explanation of removal behavior and the trade-off behind keeping historical deletion rules out of this repository. This addresses the upgrade guidance gap in #34 while leaving cleanup choices to each machine or fork.