docs: reorganize README and document missing commands#854
Merged
dsanders11 merged 2 commits intomainfrom Apr 30, 2026
Merged
Conversation
Restructure the README into logical command groups (core workflow, running Electron, inspecting state, working with code, managing configs, infrastructure) and add a table of contents for navigation. Fill in documentation for commands that were undocumented or only briefly mentioned: worktree, pr open, pr download-dist, cherry-pick, rcv, backport, gh-auth, npm, load-macos-sdk, and the show subcommands depotdir / out --path. Expand option tables for init (sanitizers, mas, target-cpu, remote-build, use-https, fork), build (--gen, --no-remote), sync (--3), test, patches (--list-targets, --commit-updates, all), and open (--print). Add a configuration file reference (schema fields, validation rules, `extends` inheritance) and an environment variables table covering EVM_*, BUILD_TOOLS_SHA, GN_EXTRA_ARGS, ELECTRON_BUILD_TOOLS_* and the other internally-set variables. Point readers at the zsh completion script under tools/zsh/_e.
dsanders11
requested changes
Apr 27, 2026
Member
dsanders11
left a comment
dsanders11
left a comment
There was a problem hiding this comment.
- Linter is unhappy
- I think the "Environment variables" section should only document ones we actually want to tell users about, right now it documented everything. This is non-exhaustive, but I'd definitely remove:
ELECTRON_OVERRIDE_DIST_PATH- implementation detailELECTRON_RUN_AS_NODE- implementation detailCI- implementation detail - if we wanted this to be public API we should give it a proper name and default the value toCI.
dsanders11
approved these changes
Apr 28, 2026
MarshallOfSound
approved these changes
Apr 29, 2026
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
3 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.
Restructure the README into logical command groups (core workflow, running Electron, inspecting state, working with code, managing configs, infrastructure) and add a table of contents for navigation.
Fill in documentation for commands that were undocumented or only briefly mentioned: worktree, pr open, pr download-dist, cherry-pick, rcv, backport, gh-auth, npm, load-macos-sdk, and the show subcommands depotdir / out --path. Expand option tables for init (sanitizers, mas, target-cpu, remote-build, use-https, fork), build (--gen, --no-remote), sync (--3), test, patches (--list-targets, --commit-updates, all), and open (--print).
Add a configuration file reference (schema fields, validation rules,
extendsinheritance) and an environment variables table covering EVM_, BUILD_TOOLS_SHA, GN_EXTRA_ARGS, ELECTRON_BUILD_TOOLS_ and the other internally-set variables. Point readers at the zsh completion script under tools/zsh/_e.