Skip to content

Docs: kebab-case the Repo layout table after rename PR #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
crutkas merged 2 commits into from
May 23, 2026
Merged

Docs: kebab-case the Repo layout table after rename PR #11

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea87a20
Docs: kebab-case the Repo layout table after rename PR
crutkas May 23, 2026
3a3ec50
Merge branch 'main' into docs/readme-layout-table-paths
crutkas May 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,18 +109,18 @@ This repo carries **two parallel copies** of every flow:

| Path | What it is | Edit it? | Run it? |
| ----------------------------- | ----------------------------------------------------------------- | -------- | -------- |
| `Windows Dev Config/` | **Signed release copy** (Authenticode). | No | **Yes** |
| `windows-dev-config/` | **Signed release copy** (Authenticode). | No | **Yes** |
| `Workloads/` | **Signed release copy** of every single-language workload. | No | **Yes** |
| `Wsl Comfort/` | **Signed release copy**. | No | **Yes** |
| `src/Windows Dev Config/` | Source. CI runs from here. | **Yes** | Yes |
| `wsl-comfort/` | **Signed release copy**. | No | **Yes** |
| `src/windows-dev-config/` | Source. CI runs from here. | **Yes** | Yes |
| `src/Workloads/` | Source. CI runs from here. | **Yes** | Yes |
| `src/Wsl Comfort/` | Source. CI runs from here. | **Yes** | Yes |
| `src/wsl-comfort/` | Source. CI runs from here. | **Yes** | Yes |
| `src/manifest.yml` | Single source-of-truth for every flow (paths, build/run, ids). | **Yes** | n/a |
| `src/future/cmdpal/` | Command Palette extension. C# project. Reads `src/manifest.yml`. | **Yes** | n/a |
| `src/docs/development.md` | Contributor docs (CI, validation, how to add a language). | **Yes** | n/a |
| `src/tests/` | Hello-world programs + expected stdout used by the CI harness. | **Yes** | CI only |

**End users**: the commands in this README point at the **top-level signed copies** on purpose. If you're following the README on a Windows box you don't need to know `src/` exists — every `winget configure -f ".\Windows Dev Config\dev-config.winget"`-style invocation in this README is correct as written.
**End users**: the commands in this README point at the **top-level signed copies** on purpose. If you're following the README on a Windows box you don't need to know `src/` exists — every `winget configure -f .\windows-dev-config\dev-config.winget`-style invocation in this README is correct as written.

**Contributors**: edit `src/`. The top-level paths are **regenerated** by [`.pipelines/OneBranch.SignAndPackage.yml`](./.pipelines/OneBranch.SignAndPackage.yml), which Authenticode-signs every `src/**/*.ps1` and ships them (plus the `.winget` configs and the manifest) as the release artifact. The signed copies were merged into `main` from the `signed` branch in [PR #6](https://github.com/microsoft/WindowsDeveloperConfig/pull/6). A change to a `src/` script becomes a new signed top-level copy on the next sign cycle, not at PR merge — so the two can briefly disagree on a script's body until that cycle runs.

Expand All @@ -131,7 +131,7 @@ This repo carries **two parallel copies** of every flow:
- Don't edit a top-level signed copy directly. The next sign cycle will overwrite it, and the cycle signs `src/`, not the top level.
- Don't expect the two trees to be byte-identical. The signed copies carry an Authenticode signature block (`# SIG # Begin signature block` … `# SIG # End signature block`); the bodies above that marker should match what's in `src/`. They will diverge for the window between a `src/` change landing on `main` and the next sign cycle catching up.
- Don't add a third copy of anything. Both copies exist for one reason only — to ship signed PS1s without losing the unsigned source — and any new flow or shared script lives only in `src/` until the sign pipeline mirrors it.
-

## Reporting issues

Found a bug, a stale doc, or a flow that fails on your machine? File an issue at [github.com/microsoft/WindowsDeveloperConfig/issues](https://github.com/microsoft/WindowsDeveloperConfig/issues). Please include your Windows build (`winver`), the exact command you ran, and the failing output.
Expand Down
Loading