docs: document branch-per-OS structure and fix clone path - #1
Draft
LJLee37 wants to merge 1 commit into
Draft
Conversation
README was byte-identical across all 6 branches with no explanation of why, and pointed at ~/gitRepos/settingfiles while arch/raspi's set.sh hard-coded ~/gitRepos/Personal/settingfiles. Document the branch layout, note master as the canonical source for shared dotfiles, and standardize the clone path (fixed in each branch's set.sh separately).
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
2 participants
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
Part of a repo-wide cleanup (companion PRs going into
arch,macOS,ubuntu,alpine,raspi, plus a newraspi-archbranch — see that PR for the Arch Linux ARM install).README.mdwas byte-identical on all 6 branches with zero explanation of why this repo uses one branch per OS instead of directories. This PR (onmaster, the common base):.vimrcis byte-identical across every branch, and that the bulk of.zshrcis shared too (only a small OS-specific tail differs — PATH, keychain/GPG setup, plugins).masteris called out as the canonical source for these shared files; since branches can't share a physical file at runtime without adding tooling (e.g. Stow, submodules) that's disproportionate for a personal dotfiles repo, the "single source of truth" here is enforced by convention + documentation, not by symlinks. Shared content itself is untouched.git clone -b <branch> ... ~/gitRepos/settingfiles— previously README said~/gitRepos/settingfilesbutarchandraspi'sset.shhard-coded~/gitRepos/Personal/settingfiles, so following the README broke those two branches' setup scripts. Standardized on~/gitRepos/settingfiles(matches README and 4 of the 6 branches already);arch/raspifixed in their own PRs.Hardcoded personal values (found repo-wide, left untouched)
Not removed or parameterized per the task — listing them here for the repo owner to decide whether to keep, parameterize, or move to a local-only config:
user.name "LJLee37",user.email "ljlee3759@gmail.com"(arch/set.sh,raspi/install.sh)8090E75C56E49652(raspi/install.sh)rpi.ljlee37.com/-P 3759(arch/set.sh)LJLeeLT, usernameljlee(arch/install2.sh)bc22c8a5-306c-4ad3-81c3-753aff6f562d(arch/set-hibernate.sh)192.168.35.203(raspi/backup.sh)keychain --agents ssh --eval ljlee_id(shared.zshrc, all branches that include it)ko_KR/ja_JP/eo(arch/install2.sh)Test plan
README.mdrenders correctly and the clone command works as documentedGenerated by Claude Code