docs(readme): split reference content into docs/ - #26
Merged
Conversation
README drops from 1676 to 602 words. Installer internals, the qualified Chromium 152 diagnostic runtime, the Linux QA checklist, and the Wayland default move into docs/, so the README covers pitch, install, features, security, hotkeys, build, and links. linux-wayland.md keeps every re-check fact and primary source but drops quoted Chromium source dumps (17.6k to 8.2k bytes).
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.
What changed
The README shrank from 1,676 words to 602. It was carrying four documents' worth of content: Windows installer internals, the qualified Chromium 152 runtime recipe, the Linux QA checklist, and the full Wayland evidence file. All four now live in
docs/, and the README covers pitch, install, features, security, hotkeys, diagnostics, build, and a documentation index.New files
docs/windows-installer.md: installer layout, switches, and artwork generation, moved unchanged from the README.docs/qualified-electron.md: the diagnostic Chromium 152 override, its measurements, and the Forge reproduction recipe, moved from the README.docs/linux-qa-checklist.md: the six-point Linux smoke-test list, moved from the README.Changed files
docs/linux-wayland.md: 2,144 words to 941. Every re-check fact, code path, and primary source survives; the quoted Chromium source dumps, issue-thread quotes, and per-section headers are gone.README.md: rebuilt. The verification status of each platform now sits in the Install section where a download decision happens, the hotkey table replaced the prose list, and a documentation index links the four docs.Unchanged on purpose
PATCHED_ELECTRON.txtandTHIRD_PARTY_NOTICES.txtstay. Both are load-bearing: the first is the supply-chain provenance for the patched Electron binary, the second is GPL attribution.Verification
pnpm run validatepasses: lint, typecheck, 586/586 tests.src/,scripts/,tests/, or the workflows references the moved content, so no code changes were needed.Next: your review. Nothing for you to do until then.