Browse Source

:heart: Feedback

Felix Rieseberg 7 years ago
parent
commit
9d4c68d272

+ 7 - 7
docs/README.md

@@ -52,11 +52,16 @@ an issue:
   * [Spectron](tutorial/accessibility.md#spectron)
   * [Devtron](tutorial/accessibility.md#devtron)
   * [Enabling Accessibility](tutorial/accessibility.md#enabling-accessibility)
+* [Application Testing and Debugging](tutorial/application-debugging.md)
+  * [Debugging the Main Process](tutorial/debugging-main-process.md)
+  * [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md)
+  * [Testing on Headless CI Systems (Travis, Jenkins)](tutorial/testing-on-headless-ci.md)
+  * [DevTools Extension](tutorial/devtools-extension.md)
 * [Application Distribution](tutorial/application-distribution.md)
+  * [Supported Platforms](tutorial/supported-platforms.md)
   * [Mac App Store](tutorial/mac-app-store-submission-guide.md)
   * [Windows Store](tutorial/windows-store-guide.md)
   * [Snapcraft](tutorial/snapcraft.md)
-  * [Supported Platforms](tutorial/supported-platforms.md)
 * [Application Security](tutorial/security.md)
   * [Reporting Security Issues](tutorial/security.md#reporting-security-issues)
   * [Chromium Security Issues and Upgrades](tutorial/security.md#chromium-security-issues-and-upgrades)
@@ -66,15 +71,10 @@ an issue:
   * [Deploying an Update Server](tutorial/updates.md#deploying-an-update-server)
   * [Implementing Updates in Your App](tutorial/updates.md#implementing-updates-in-your-app)
   * [Applying Updates](tutorial/updates.md#applying-updates)
-* [Application Debugging](tutorial/application-debugging.md)
-  * [Debugging the Main Process](tutorial/debugging-main-process.md)
-  * [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md)
-  * [Testing on Headless CI Systems (Travis, Jenkins)](tutorial/testing-on-headless-ci.md)
-  * [DevTools Extension](tutorial/devtools-extension.md)
 
 ## Detailed Tutorials
 
-These individual tutorial expand on topics discussed in the guide above.
+These individual tutorials expand on topics discussed in the guide above.
 
 * [In Detail: Installing Electron](tutorial/installation.md)
   * [Global versus Local Installation](tutorial/installation.md#global-versus-local-installation)

+ 2 - 2
docs/tutorial/application-debugging.md

@@ -6,8 +6,8 @@ bottlenecks, or optimization opportunities.
 
 ## Renderer Process
 
-The most comprehensive tool to debug individual renderer processes are the
-Chromium Developer Tools. They are available for all renderer processes,
+The most comprehensive tool to debug individual renderer processes is the
+Chromium Developer Toolset. It is available for all renderer processes,
 including instances of `BrowserWindow`, `BrowserView`, and `WebView`. You
 can open them programmatically by calling the `openDevTools()` API on the
 `webContents` of the instance:

+ 2 - 2
docs/tutorial/boilerplates-and-clis.md

@@ -8,7 +8,7 @@ the app and build pipeline they need.
 
 That level of modularity and extendability ensures that all developers working
 with Electron, both big and small in team-size, are never restricted in what
-they can or cannot do at any time during their development life-cycle. However,
+they can or cannot do at any time during their development lifecycle. However,
 for many developers, one of the community-driven boilerplates or command line
 tools might make it dramatically easier to compile, package, and release an
 app.
@@ -42,7 +42,7 @@ You can find more information and documentation on [electronforge.io][forge].
 
 A "complete solution to package and build a ready-for-distribution Electron app"
 that focuses on an integrated experience. [`electron-builder`][builder] adds one
-single dependency focuses on simplicity and manages all further requirments
+single dependency focused on simplicity and manages all further requirements
 internally.
 
 `electron-builder` replaces features and modules used by the Electron

+ 8 - 5
docs/tutorial/development-environment.md

@@ -7,15 +7,18 @@ rudimentary understanding of your operating system's command line client.
 
 ## Setting up macOS
 
-> Electron supports Mac OS X 10.9 (and all versions named macOS) and up. Apple does
-not allow running macOS in virtual machines unless the host computer is already
-an Apple computer, so if you find yourself in need of a Mac, consider using a
-cloud service that rents access to Macs (like [MacInCloud][macincloud] or
-[xcloud](https://xcloud.me)).
+> Electron supports Mac OS X 10.9 (and all versions named macOS) and up. Apple
+does not allow running macOS in virtual machines unless the host computer is
+already an Apple computer, so if you find yourself in need of a Mac, consider
+using a cloud service that rents access to Macs (like [MacInCloud][macincloud]
+or [xcloud](https://xcloud.me)).
 
 First, install a recent version of Node.js. We recommend that you install
 either the latest `LTS` or `Current` version available. Visit
 [the Node.js download page][node-download] and select the `macOS Installer`.
+While Homebrew is an offered option, but we recommend against it - many tools
+will be incompatible with the way Homebrew installs Node.js.
+
 Once downloaded, execute the installer and let the installation wizard guide
 you through the installation.
 

+ 16 - 16
docs/tutorial/first-app.md

@@ -37,9 +37,9 @@ run the main process. An example of your `package.json` might look like this:
 
 ```json
 {
-  "name"    : "your-app",
-  "version" : "0.1.0",
-  "main"    : "main.js"
+  "name": "your-app",
+  "version": "0.1.0",
+  "main": "main.js"
 }
 ```
 
@@ -50,11 +50,11 @@ to execute the current package:
 
 ```json
 {
-  "name"    : "your-app",
-  "version" : "0.1.0",
-  "main"    : "main.js",
-  "scripts" : {
-    "start" : "node ."
+  "name": "your-app",
+  "version": "0.1.0",
+  "main": "main.js",
+  "scripts": {
+    "start": "node ."
   }
 }
 ```
@@ -64,11 +64,11 @@ merely replace the `node` runtime with the `electron` runtime.
 
 ```json
 {
-  "name"    : "your-app",
-  "version" : "0.1.0",
-  "main"    : "main.js",
-  "scripts" : {
-    "start" : "electron ."
+  "name": "your-app",
+  "version": "0.1.0",
+  "main": "main.js",
+  "scripts": {
+    "start": "electron ."
   }
 }
 ```
@@ -99,9 +99,9 @@ Node.js module:
 const electron = require('electron')
 ```
 
-The `electron` module exposes is feature in namespaces. The lifecycle of the
-application is managed through `electron.app`, windows can be created using
-the `electron.BrowserWindow` class. A simple `main.js` file might just wait
+The `electron` module exposes features in namespaces. As examples, the lifecycle
+of the application is managed through `electron.app`, windows can be created
+using the `electron.BrowserWindow` class. A simple `main.js` file might just wait
 for the application to be ready and open a window:
 
 ```javascript

+ 1 - 1
docs/tutorial/linux-desktop-actions.md

@@ -3,7 +3,7 @@
 On many Linux environments, you can add custom entries to its launcher
 by modifying the `.desktop` file. For Canonical's Unity documentation,
 see [Adding Shortcuts to a Launcher][unity-launcher]. For details on a
-more generic implementation, see the [Free Desktop Specification][spec].
+more generic implementation, see the [freedesktop.org Specification][spec].
 
 __Launcher shortcuts of Audacious:__