Docs: explain src/ vs the signed top-level copies in README#8
Merged
Conversation
The repo carries two parallel copies of every flow - the top-level 'Windows Dev Config/', 'Workloads/', and 'Wsl Comfort/' directories are Authenticode-signed release copies, while 'src/...' is the unsigned source CI runs from. The README's run commands point at the top-level signed copies; CI and src/docs/development.md point at src/. Nothing in the top-level README explains the split, so a first-time reader can't tell which copy is canonical, which to edit, or why a 'src/Windows Dev Config/' even exists next to a 'Windows Dev Config/'. Add a 'Repo layout: signed vs source' section to the top-level README that: - Lists every path with a one-line description, whether contributors should edit it, and whether end users run it. - States explicitly that the README's run commands point at the signed top-level copies on purpose - end users don't need to know src/ exists. - States explicitly that contributors edit src/, that the top-level copies are regenerated by .pipelines/OneBranch.SignAndPackage.yml, and that those signed copies were merged from the 'signed' branch in PR #6. - Notes that CI runs the unsigned src/ copies intentionally (signing is a release-time, not build-time, concern). - Calls out three 'don'ts': don't edit a top-level signed copy, don't expect the two trees to be byte-identical (signature block aside), and don't add a third copy. Placed between 'Command Palette extension' and 'Troubleshooting' so a reader who's followed the existing flow descriptions hits it once they start looking around the repo. Pure documentation change; no code movement. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
niels9001
approved these changes
May 23, 2026
crutkas
added a commit
that referenced
this pull request
May 23, 2026
When PRs #8 and #9 landed in that order, PR #8's 'Repo layout: signed vs source' section was merged with the spaced paths (Windows Dev Config/, Wsl Comfort/) baked in, and PR #9's rename did not retroactively update that table. After both PRs the README points readers at four paths that no longer exist on disk. Three small fixes, all inside the Repo layout section: - Update the 4-column path table to kebab-case: windows-dev-config/, wsl-comfort/, src/windows-dev-config/, src/wsl-comfort/. - Update the inline 'every winget configure -f ...-style invocation in this README is correct as written' example to drop the now-unnecessary surrounding quotes and use windows-dev-config. - Remove the stray '- ' empty bullet that landed at the end of the 'Don't' list (likely a stray trailing dash in the PR #8 source). No new content. No structural changes elsewhere. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
Adds a
Repo layout: signed vs sourcesection to the top-levelREADME.md. Pure documentation change; no code or file moves.Why
The repo carries two parallel copies of every flow:
Windows Dev Config/,Workloads/,Wsl Comfort/at the top level — Authenticode-signed release copies.src/Windows Dev Config/,src/Workloads/,src/Wsl Comfort/— the unsigned source contributors edit and CI runs from.The README's
winget configure -f ".\Windows Dev Config\dev-config.winget"-style commands all point at the top-level signed copies, while.github/workflows/ci.ymlandsrc/docs/development.mdpoint atsrc/. Today nothing in the top-level README mentions the split at all, so a first-time reader genuinely can't tell:src/Windows Dev Config/even exists next toWindows Dev Config/,signedbranch in Add signed files #6).What the new section says
A small 4-column table covering every top-level and
src/path with what it is, edit it?, and run it?, followed by four short prose blocks aimed at distinct readers:src/exists.src/; the top-level paths are regenerated by.pipelines/OneBranch.SignAndPackage.yml; the signed copies were merged fromsignedin Add signed files #6; asrc/edit only becomes a new signed top-level copy on the next sign cycle, not at PR merge.src/copies on purpose; signing is a release-time concern, not a build-time one.Placement
Inserted between the existing Command Palette extension and Troubleshooting sections. A reader who's already read the flow descriptions hits the layout section right when they start looking around the repo.
Diff
29 lines added, 0 removed, no other files touched.