From 624b6b97626d9baef48f60b67d84031b0a614870 Mon Sep 17 00:00:00 2001
From: Jessica Lord <jlord@github.com>
Date: Wed, 19 Aug 2015 18:28:48 +0200
Subject: [PATCH 01/12] Standardize app.md

---
 docs/api/app.md | 138 +++++++++++++++++++++++++-----------------------
 1 file changed, 72 insertions(+), 66 deletions(-)

diff --git a/docs/api/app.md b/docs/api/app.md
index 8223643a375..2a625ec3c18 100644
--- a/docs/api/app.md
+++ b/docs/api/app.md
@@ -11,7 +11,11 @@ app.on('window-all-closed', function() {
 });
 ```
 
-## Event: will-finish-launching
+## Events
+
+The following are events on `app`.
+
+### Event: 'will-finish-launching'
 
 Emitted when the application has finished basic startup. On Windows and Linux,
 the `will-finish-launching` event is the same as the `ready` event; on OS X,
@@ -21,20 +25,20 @@ and start the crash reporter and auto updater.
 
 In most cases, you should just do everything in the `ready` event handler.
 
-## Event: ready
+### Event: 'ready'
 
 Emitted when Electron has finished initialization.
 
-## Event: window-all-closed
+### Event: 'window-all-closed'
 
 Emitted when all windows have been closed.
 
 This event is only emitted when the application is not going to quit. If the
-user pressed `Cmd + Q`, or the developer called `app.quit()`, Electron would
+user pressed `Cmd + Q`, or the developer called `app.quit()`, Electron will
 first try to close all the windows and then emit the `will-quit` event, and in
 this case the `window-all-closed` event would not be emitted.
 
-## Event: before-quit
+### Event: 'before-quit'
 
 * `event` Event
 
@@ -42,7 +46,7 @@ Emitted before the application starts closing its windows.
 Calling `event.preventDefault()` will prevent the default behaviour, which is
 terminating the application.
 
-## Event: will-quit
+### Event: 'will-quit'
 
 * `event` Event
 
@@ -50,14 +54,13 @@ Emitted when all windows have been closed and the application will quit.
 Calling `event.preventDefault()` will prevent the default behaviour, which is
 terminating the application.
 
-See the description of the `window-all-closed` event for the differences between the `will-quit`
-and `window-all-closed` events.
+See the description of the `window-all-closed` event for the differences between the `will-quit` and `window-all-closed` events.
 
-## Event: quit
+### Event: 'quit'
 
 Emitted when the application is quitting.
 
-## Event: open-file
+### Event: 'open-file'
 
 * `event` Event
 * `path` String
@@ -71,7 +74,7 @@ event very early in your application startup to handle this case (even before th
 
 You should call `event.preventDefault()` if you want to handle this event.
 
-## Event: open-url
+### Event: 'open-url'
 
 * `event` Event
 * `url` String
@@ -81,20 +84,20 @@ must be registered to be opened by your application.
 
 You should call `event.preventDefault()` if you want to handle this event.
 
-## Event: activate-with-no-open-windows
+### Event: 'activate-with-no-open-windows'
 
 Emitted when the application is activated while there are no open windows, which
 usually happens when the user has closed all of the application's windows and then
 clicks on the application's dock icon.
 
-## Event: browser-window-blur
+### Event: 'browser-window-blur'
 
 * `event` Event
 * `window` BrowserWindow
 
 Emitted when a [browserWindow](browser-window.md) gets blurred.
 
-## Event: browser-window-focus
+### Event: 'browser-window-focus'
 
 * `event` Event
 * `window` BrowserWindow
@@ -113,25 +116,28 @@ Emitted when a client certificate is requested.
   * `issuerName` Issuer's Common Name
 * `callback` Function
 
-```
+```javascript
 app.on('select-certificate', function(event, host, url, list, callback) {
   event.preventDefault();
   callback(list[0]);
 })
 ```
 
-`url` corresponds to the navigation entry requesting the client certificate.
-`callback` needs to be called with an entry filtered from the list.
-`event.preventDefault()` prevents the application from using the first certificate
+The `url` corresponds to the navigation entry requesting the client certificate and `callback` needs to be called with an entry filtered from the list.
+Using `event.preventDefault()` prevents the application from using the first certificate
 from the store.
 
 ### Event: 'gpu-process-crashed'
 
 Emitted when the gpu process crashes.
 
-## app.quit()
+## Methods
 
-Try to close all windows. The `before-quit` event will first be emitted. If all
+The following are methods on the `app` class.
+
+### `app.quit()`
+
+Try to close all windows. The `before-quit` event will emitted first. If all
 windows are successfully closed, the `will-quit` event will be emitted and by
 default the application will terminate.
 
@@ -139,11 +145,11 @@ This method guarantees that all `beforeunload` and `unload` event handlers are c
 executed. It is possible that a window cancels the quitting by returning
 `false` in the `beforeunload` event handler.
 
-## app.getAppPath()
+### `app.getAppPath()`
 
 Returns the current application directory.
 
-## app.getPath(name)
+### `app.getPath(name)`
 
 * `name` String
 
@@ -152,25 +158,25 @@ failure an `Error` is thrown.
 
 You can request the following paths by the name:
 
-* `home`: User's home directory
-* `appData`: Per-user application data directory, which by default points to:
+* `home` User's home directory.
+* `appData` Per-user application data directory, which by default points to:
   * `%APPDATA%` on Windows
   * `$XDG_CONFIG_HOME` or `~/.config` on Linux
   * `~/Library/Application Support` on OS X
-* `userData`: The directory for storing your app's configuration files, which by
-  default it is the `appData` directory appended with your app's name
-* `cache`: Per-user application cache directory, which by default points to:
+* `userData` The directory for storing your app's configuration files, which by
+  default it is the `appData` directory appended with your app's name.
+* `cache` Per-user application cache directory, which by default points to:
   * `%APPDATA%` on Windows (which doesn't have a universal cache location)
   * `$XDG_CACHE_HOME` or `~/.cache` on Linux
   * `~/Library/Caches` on OS X
-* `userCache`: The directory for placing your app's caches, by default it is the
- `cache` directory appended with your app's name
-* `temp`: Temporary directory
-* `userDesktop`: The current user's Desktop directory
-* `exe`: The current executable file
-* `module`: The `libchromiumcontent` library
+* `userCache` The directory for placing your app's caches, by default it is the
+ `cache` directory appended with your app's name.
+* `temp` Temporary directory.
+* `userDesktop` The current user's Desktop directory.
+* `exe` The current executable file.
+* `module` The `libchromiumcontent` library.
 
-## app.setPath(name, path)
+### `app.setPath(name, path)`
 
 * `name` String
 * `path` String
@@ -179,19 +185,19 @@ Overrides the `path` to a special directory or file associated with `name`. If
 the path specifies a directory that does not exist, the directory will be
 created by this method. On failure an `Error` is thrown.
 
-You can only override paths of `name`s  defined in `app.getPath`.
+You can only override paths of a `name` defined in `app.getPath`.
 
-By default, web pages' cookies and caches will be stored under the `userData`
+By default, web pages's cookies and caches will be stored under the `userData`
 directory. If you want to change this location, you have to override the
 `userData` path before the `ready` event of the `app` module is emitted.
 
-## app.getVersion()
+### `app.getVersion()`
 
 Returns the version of the loaded application. If no version is found in the
 application's `package.json` file, the version of the current bundle or executable is
 returned.
 
-## app.getName()
+### `app.getName()`
 
 Returns the current application's name, which is the name in the application's
 `package.json` file.
@@ -201,7 +207,7 @@ to the npm modules spec. You should usually also specify a `productName`
 field, which is your application's full capitalized name, and which will be
 preferred over `name` by Electron.
 
-## app.resolveProxy(url, callback)
+### `app.resolveProxy(url, callback)`
 
 * `url` URL
 * `callback` Function
@@ -209,7 +215,7 @@ preferred over `name` by Electron.
 Resolves the proxy information for `url`. The `callback` will be called with
 `callback(proxy)` when the request is performed.
 
-## app.addRecentDocument(path)
+### `app.addRecentDocument(path)`
 
 * `path` String
 
@@ -218,11 +224,11 @@ Adds `path` to the recent documents list.
 This list is managed by the OS. On Windows you can visit the list from the task
 bar, and on OS X you can visit it from dock menu.
 
-## app.clearRecentDocuments()
+### `app.clearRecentDocuments()`
 
 Clears the recent documents list.
 
-## app.setUserTasks(tasks)
+### `app.setUserTasks(tasks)`
 
 * `tasks` Array - Array of `Task` objects
 
@@ -230,36 +236,36 @@ Adds `tasks` to the [Tasks][tasks] category of the JumpList on Windows.
 
 `tasks` is an array of `Task` objects in following format:
 
-* `Task` Object
-  * `program` String - Path of the program to execute, usually you should
-    specify `process.execPath` which opens the current program
-  * `arguments` String - The command line arguments when `program` is
-    executed
-  * `title` String - The string to be displayed in a JumpList
-  * `description` String - Description of this task
-  * `iconPath` String - The absolute path to an icon to be displayed in a
-    JumpList, which can be an arbitrary resource file that contains an icon. You can 
-    usually specify `process.execPath` to show the icon of the program
-  * `iconIndex` Integer - The icon index in the icon file. If an icon file
-    consists of two or more icons, set this value to identify the icon. If an
-    icon file consists of one icon, this value is 0
+`Task` Object
+* `program` String - Path of the program to execute, usually you should
+  specify `process.execPath` which opens the current program.
+* `arguments` String - The command line arguments when `program` is
+  executed.
+* `title` String - The string to be displayed in a JumpList.
+* `description` String - Description of this task.
+* `iconPath` String - The absolute path to an icon to be displayed in a
+  JumpList, which can be an arbitrary resource file that contains an icon. You can
+  usually specify `process.execPath` to show the icon of the program.
+* `iconIndex` Integer - The icon index in the icon file. If an icon file
+  consists of two or more icons, set this value to identify the icon. If an
+  icon file consists of one icon, this value is 0.
 
 **Note:** This API is only available on Windows.
 
-## app.commandLine.appendSwitch(switch, [value])
+### `app.commandLine.appendSwitch(switch[, value])`
 
-Append a switch [with optional value] to Chromium's command line.
+Append a switch (with optional `value`) to Chromium's command line.
 
 **Note:** This will not affect `process.argv`, and is mainly used by developers
 to control some low-level Chromium behaviors.
 
-## app.commandLine.appendArgument(value)
+### `app.commandLine.appendArgument(value)`
 
 Append an argument to Chromium's command line. The argument will be quoted correctly.
 
 **Note:** This will not affect `process.argv`.
 
-## app.dock.bounce([type])
+### app.dock.bounce([type])
 
 * `type` String - Can be `critical` or `informational`. The default is
  `informational`
@@ -271,11 +277,11 @@ When `informational` is passed, the dock icon will bounce for one second. Howeve
 the request remains active until either the application becomes active or
 the request is canceled.
 
-An ID representing the request is returned.
+Returns an ID representing the request.
 
 **Note:** This API is only available on OS X.
 
-## app.dock.cancelBounce(id)
+### `app.dock.cancelBounce(id)`
 
 * `id` Integer
 
@@ -283,7 +289,7 @@ Cancel the bounce of `id`.
 
 **Note:** This API is only available on OS X.
 
-## app.dock.setBadge(text)
+### `app.dock.setBadge(text)`
 
 * `text` String
 
@@ -291,25 +297,25 @@ Sets the string to be displayed in the dock’s badging area.
 
 **Note:** This API is only available on OS X.
 
-## app.dock.getBadge()
+### `app.dock.getBadge()`
 
 Returns the badge string of the dock.
 
 **Note:** This API is only available on OS X.
 
-## app.dock.hide()
+### `app.dock.hide()`
 
 Hides the dock icon.
 
 **Note:** This API is only available on OS X.
 
-## app.dock.show()
+### `app.dock.show()`
 
 Shows the dock icon.
 
 **Note:** This API is only available on OS X.
 
-## app.dock.setMenu(menu)
+### `app.dock.setMenu(menu)`
 
 * `menu` Menu
 

From 714745cdd7add683c54ad6bf2e1e82914aef3eae Mon Sep 17 00:00:00 2001
From: Jessica Lord <jlord@github.com>
Date: Wed, 19 Aug 2015 18:51:36 +0200
Subject: [PATCH 02/12] Add 'returns' and change h2 descriptions

---
 docs/api/app.md | 18 ++++++++++++++++--
 1 file changed, 16 insertions(+), 2 deletions(-)

diff --git a/docs/api/app.md b/docs/api/app.md
index 2a625ec3c18..6a54dba3021 100644
--- a/docs/api/app.md
+++ b/docs/api/app.md
@@ -13,7 +13,7 @@ app.on('window-all-closed', function() {
 
 ## Events
 
-The following are events on `app`.
+The `app` object emits the following events:
 
 ### Event: 'will-finish-launching'
 
@@ -40,6 +40,8 @@ this case the `window-all-closed` event would not be emitted.
 
 ### Event: 'before-quit'
 
+Returns:
+
 * `event` Event
 
 Emitted before the application starts closing its windows.
@@ -48,6 +50,8 @@ terminating the application.
 
 ### Event: 'will-quit'
 
+Returns:
+
 * `event` Event
 
 Emitted when all windows have been closed and the application will quit.
@@ -62,6 +66,8 @@ Emitted when the application is quitting.
 
 ### Event: 'open-file'
 
+Returns:
+
 * `event` Event
 * `path` String
 
@@ -76,6 +82,8 @@ You should call `event.preventDefault()` if you want to handle this event.
 
 ### Event: 'open-url'
 
+Returns:
+
 * `event` Event
 * `url` String
 
@@ -92,6 +100,8 @@ clicks on the application's dock icon.
 
 ### Event: 'browser-window-blur'
 
+Returns:
+
 * `event` Event
 * `window` BrowserWindow
 
@@ -99,6 +109,8 @@ Emitted when a [browserWindow](browser-window.md) gets blurred.
 
 ### Event: 'browser-window-focus'
 
+Returns:
+
 * `event` Event
 * `window` BrowserWindow
 
@@ -108,6 +120,8 @@ Emitted when a [browserWindow](browser-window.md) gets focused.
 
 Emitted when a client certificate is requested.
 
+Returns:
+
 * `event` Event
 * `webContents` [WebContents](browser-window.md#class-webcontents)
 * `url` String
@@ -133,7 +147,7 @@ Emitted when the gpu process crashes.
 
 ## Methods
 
-The following are methods on the `app` class.
+The `app` object has the following methods:
 
 ### `app.quit()`
 

From 454413f69ab6a33e9bc6baa7429390246ed529f0 Mon Sep 17 00:00:00 2001
From: Jessica Lord <jlord@github.com>
Date: Wed, 19 Aug 2015 18:55:11 +0200
Subject: [PATCH 03/12] Standardize auto-updater.md

---
 docs/api/auto-updater.md | 28 ++++++++++++++++++++--------
 1 file changed, 20 insertions(+), 8 deletions(-)

diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md
index 5274fc6c467..b2ebcc40a44 100644
--- a/docs/api/auto-updater.md
+++ b/docs/api/auto-updater.md
@@ -1,4 +1,4 @@
-# auto-updater
+# autoUpdater
 
 **This module has only been implemented for OS X.**
 
@@ -98,27 +98,35 @@ appropriate format.
 
 `pub_date` (if present) must be formatted according to ISO 8601.
 
-## Event: error
+## Events
+
+The `autoUpdater` object emits the following events:
+
+### Event: 'error'
+
+Returns:
 
 * `event` Event
 * `message` String
 
 Emitted when there is an error while updating.
 
-## Event: checking-for-update
+### Event: 'checking-for-update'
 
 Emitted when checking if an update has started.
 
-## Event: update-available
+### Event: 'update-available'
 
 Emitted when there is an available update. The update is downloaded
 automatically.
 
-## Event: update-not-available
+### Event: 'update-not-available'
 
 Emitted when there is no available update.
 
-## Event: update-downloaded
+### Event: 'update-downloaded'
+
+Returns:
 
 * `event` Event
 * `releaseNotes` String
@@ -130,14 +138,18 @@ Emitted when there is no available update.
 Emitted when an update has been downloaded. Calling `quitAndUpdate()` will restart
 the application and install the update.
 
-## autoUpdater.setFeedUrl(url)
+## Methods
+
+The `autoUpdater` object has the following methods:
+
+### `autoUpdater.setFeedUrl(url)`
 
 * `url` String
 
 Set the `url` and initialize the auto updater. The `url` cannot be changed
 once it is set.
 
-## autoUpdater.checkForUpdates()
+### `autoUpdater.checkForUpdates()`
 
 Ask the server whether there is an update. You must call `setFeedUrl` before
 using this API.

From acc0c616c4366b3a92419b78ad76be82251eeece Mon Sep 17 00:00:00 2001
From: Jessica Lord <jlord@github.com>
Date: Sat, 22 Aug 2015 14:07:45 +0200
Subject: [PATCH 04/12] Spec out doc styleguide

---
 docs/styleguide.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 docs/styleguide.md

diff --git a/docs/styleguide.md b/docs/styleguide.md
new file mode 100644
index 00000000000..a6189a79f25
--- /dev/null
+++ b/docs/styleguide.md
@@ -0,0 +1,63 @@
+# Electron Documentation Styleguide
+
+Find the appropriate section for your task: [reading Electron documentation](#) or [writing Electron documentation](#).
+
+## Writing Electron Documentation
+
+These are the ways that we construct the Electron documentation.
+
+- Maximum one `h1` title per page.
+- Use `bash` instead of `cmd` in code blocks (because of syntax highlighter).
+- Doc `h1` titles should match object name (i.e. `browser-window` → `BrowserWindow`).
+  - Hyphen separated filenames, however, are fine.
+- No headers following headers, add at least a one-sentence description.
+- Methods headers are wrapped in `code` ticks.
+- Event headers are wrapped in singe 'quotation' marks.
+- No nesting lists more than 2 levels (unfortunately because of markdown renderer).
+- Add section titles: Events, Class Methods and Instance Methods.
+- Use 'will' over 'would' when describing outcomes.
+- Events and methods are `h3` headers.
+- Optional arguments written as `function (required[, optional])`.
+
+## Reading Electron Documentation
+
+Here are some tips for understanding Electron documentation syntax.
+
+### Methods
+
+An example of [method](https://developer.mozilla.org/en-US/docs/Glossary/Method) documentation:
+
+---
+
+`methodName(required[, optional]))`
+
+* `require` String, **required**
+* `optional` Integer
+
+---
+
+The method name is followed by the arguments it takes. Optional arguments are notated by brackets surrounding the optional argument as well as the comma required if this optional argument follows another argument.
+
+Below the method is more detailed information on each of the arguments. The type of argument is notated by either the common types: [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object), [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) or a custom type like Electron's [`webContent`](api/web-content.md).
+
+### Events
+
+An example of [event](https://developer.mozilla.org/en-US/docs/Web/API/Event) documentation:
+
+---
+
+Event: 'wake-up'
+
+Returns:
+
+* `time` String
+
+---
+
+The event is a string that is used after a `.on` listener method. If it returns a value it and its type is noted below. If you were to listen and respond to this event it might look something like this:
+
+```javascript
+Alarm.on('wake-up', function(time) {
+  console.log(time)
+})
+```

From d7fda9c8cc93cbc5bbe5863d93ad187a8a6fd421 Mon Sep 17 00:00:00 2001
From: Jessica Lord <jlord@github.com>
Date: Sun, 23 Aug 2015 11:17:19 +0200
Subject: [PATCH 05/12] Add links to docs translations

---
 docs/README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/docs/README.md b/docs/README.md
index d61df787c9d..a16113864d2 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -66,3 +66,9 @@ Modules for both processes:
 * [Build instructions (Windows)](development/build-instructions-windows.md)
 * [Build instructions (Linux)](development/build-instructions-linux.md)
 * [Setting up symbol server in debugger](development/setting-up-symbol-server.md)
+
+## Documentation Translations
+
+- [Korean](https://github.com/atom/electron/tree/master/docs-translations/ko)
+- [Japanese](https://github.com/atom/electron/tree/master/docs-translations/jp)
+- [Spanish](https://github.com/atom/electron/tree/master/docs-translations/es)

From 9b84dc4e1afbd5fdeed1d85abbc4a855ab091aeb Mon Sep 17 00:00:00 2001
From: Jessica Lord <jlord@github.com>
Date: Mon, 24 Aug 2015 14:38:29 +0200
Subject: [PATCH 06/12] Line wrap 80

---
 docs/api/app.md          | 58 +++++++++++++++++++++-------------------
 docs/api/auto-updater.md |  4 +--
 docs/styleguide.md       | 27 +++++++++++++------
 3 files changed, 52 insertions(+), 37 deletions(-)

diff --git a/docs/api/app.md b/docs/api/app.md
index 6a54dba3021..a79b84a285a 100644
--- a/docs/api/app.md
+++ b/docs/api/app.md
@@ -2,7 +2,8 @@
 
 The `app` module is responsible for controlling the application's lifecycle.
 
-The following example shows how to quit the application when the last window is closed:
+The following example shows how to quit the application when the last window is
+closed:
 
 ```javascript
 var app = require('app');
@@ -19,9 +20,9 @@ The `app` object emits the following events:
 
 Emitted when the application has finished basic startup. On Windows and Linux,
 the `will-finish-launching` event is the same as the `ready` event; on OS X,
-this event represents the `applicationWillFinishLaunching` notification of `NSApplication`.
-You would usually set up listeners for the `open-file` and `open-url` events here,
-and start the crash reporter and auto updater.
+this event represents the `applicationWillFinishLaunching` notification of
+`NSApplication`. You would usually set up listeners for the `open-file` and
+`open-url` events here, and start the crash reporter and auto updater.
 
 In most cases, you should just do everything in the `ready` event handler.
 
@@ -58,7 +59,8 @@ Emitted when all windows have been closed and the application will quit.
 Calling `event.preventDefault()` will prevent the default behaviour, which is
 terminating the application.
 
-See the description of the `window-all-closed` event for the differences between the `will-quit` and `window-all-closed` events.
+See the description of the `window-all-closed` event for the differences between
+the `will-quit` and `window-all-closed` events.
 
 ### Event: 'quit'
 
@@ -71,12 +73,12 @@ Returns:
 * `event` Event
 * `path` String
 
-Emitted when the user wants to open a file with the application. The `open-file` event
-is usually emitted when the application is already open and the OS wants to reuse the
-application to open the file. `open-file` is also emitted when a file is dropped onto the
-dock and the application is not yet running. Make sure to listen for the `open-file`
-event very early in your application startup to handle this case (even before the
-`ready` event is emitted).
+Emitted when the user wants to open a file with the application. The `open-file`
+event is usually emitted when the application is already open and the OS wants
+to reuse the application to open the file. `open-file` is also emitted when a
+file is dropped onto the dock and the application is not yet running. Make sure
+to listen for the `open-file` event very early in your application startup to
+handle this case (even before the `ready` event is emitted).
 
 You should call `event.preventDefault()` if you want to handle this event.
 
@@ -95,8 +97,8 @@ You should call `event.preventDefault()` if you want to handle this event.
 ### Event: 'activate-with-no-open-windows'
 
 Emitted when the application is activated while there are no open windows, which
-usually happens when the user has closed all of the application's windows and then
-clicks on the application's dock icon.
+usually happens when the user has closed all of the application's windows and
+then clicks on the application's dock icon.
 
 ### Event: 'browser-window-blur'
 
@@ -137,9 +139,10 @@ app.on('select-certificate', function(event, host, url, list, callback) {
 })
 ```
 
-The `url` corresponds to the navigation entry requesting the client certificate and `callback` needs to be called with an entry filtered from the list.
-Using `event.preventDefault()` prevents the application from using the first certificate
-from the store.
+The `url` corresponds to the navigation entry requesting the client certificate
+and `callback` needs to be called with an entry filtered from the list. Using
+`event.preventDefault()` prevents the application from using the first
+certificate from the store.
 
 ### Event: 'gpu-process-crashed'
 
@@ -155,9 +158,9 @@ Try to close all windows. The `before-quit` event will emitted first. If all
 windows are successfully closed, the `will-quit` event will be emitted and by
 default the application will terminate.
 
-This method guarantees that all `beforeunload` and `unload` event handlers are correctly
-executed. It is possible that a window cancels the quitting by returning
-`false` in the `beforeunload` event handler.
+This method guarantees that all `beforeunload` and `unload` event handlers are
+correctly executed. It is possible that a window cancels the quitting by
+returning `false` in the `beforeunload` event handler.
 
 ### `app.getAppPath()`
 
@@ -208,8 +211,8 @@ directory. If you want to change this location, you have to override the
 ### `app.getVersion()`
 
 Returns the version of the loaded application. If no version is found in the
-application's `package.json` file, the version of the current bundle or executable is
-returned.
+application's `package.json` file, the version of the current bundle or
+executable is returned.
 
 ### `app.getName()`
 
@@ -258,8 +261,8 @@ Adds `tasks` to the [Tasks][tasks] category of the JumpList on Windows.
 * `title` String - The string to be displayed in a JumpList.
 * `description` String - Description of this task.
 * `iconPath` String - The absolute path to an icon to be displayed in a
-  JumpList, which can be an arbitrary resource file that contains an icon. You can
-  usually specify `process.execPath` to show the icon of the program.
+  JumpList, which can be an arbitrary resource file that contains an icon. You
+  can usually specify `process.execPath` to show the icon of the program.
 * `iconIndex` Integer - The icon index in the icon file. If an icon file
   consists of two or more icons, set this value to identify the icon. If an
   icon file consists of one icon, this value is 0.
@@ -275,7 +278,8 @@ to control some low-level Chromium behaviors.
 
 ### `app.commandLine.appendArgument(value)`
 
-Append an argument to Chromium's command line. The argument will be quoted correctly.
+Append an argument to Chromium's command line. The argument will be quoted
+correctly.
 
 **Note:** This will not affect `process.argv`.
 
@@ -287,9 +291,9 @@ Append an argument to Chromium's command line. The argument will be quoted corre
 When `critical` is passed, the dock icon will bounce until either the
 application becomes active or the request is canceled.
 
-When `informational` is passed, the dock icon will bounce for one second. However,
-the request remains active until either the application becomes active or
-the request is canceled.
+When `informational` is passed, the dock icon will bounce for one second.
+However, the request remains active until either the application becomes active
+or the request is canceled.
 
 Returns an ID representing the request.
 
diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md
index b2ebcc40a44..4e1dc5e0deb 100644
--- a/docs/api/auto-updater.md
+++ b/docs/api/auto-updater.md
@@ -135,8 +135,8 @@ Returns:
 * `updateUrl` String
 * `quitAndUpdate` Function
 
-Emitted when an update has been downloaded. Calling `quitAndUpdate()` will restart
-the application and install the update.
+Emitted when an update has been downloaded. Calling `quitAndUpdate()` will
+restart the application and install the update.
 
 ## Methods
 
diff --git a/docs/styleguide.md b/docs/styleguide.md
index a6189a79f25..e10cfc3313e 100644
--- a/docs/styleguide.md
+++ b/docs/styleguide.md
@@ -1,6 +1,7 @@
 # Electron Documentation Styleguide
 
-Find the appropriate section for your task: [reading Electron documentation](#) or [writing Electron documentation](#).
+Find the appropriate section for your task: [reading Electron documentation](#)
+or [writing Electron documentation](#).
 
 ## Writing Electron Documentation
 
@@ -8,12 +9,14 @@ These are the ways that we construct the Electron documentation.
 
 - Maximum one `h1` title per page.
 - Use `bash` instead of `cmd` in code blocks (because of syntax highlighter).
-- Doc `h1` titles should match object name (i.e. `browser-window` → `BrowserWindow`).
+- Doc `h1` titles should match object name (i.e. `browser-window` →
+  `BrowserWindow`).
   - Hyphen separated filenames, however, are fine.
 - No headers following headers, add at least a one-sentence description.
 - Methods headers are wrapped in `code` ticks.
 - Event headers are wrapped in singe 'quotation' marks.
-- No nesting lists more than 2 levels (unfortunately because of markdown renderer).
+- No nesting lists more than 2 levels (unfortunately because of markdown
+  renderer).
 - Add section titles: Events, Class Methods and Instance Methods.
 - Use 'will' over 'would' when describing outcomes.
 - Events and methods are `h3` headers.
@@ -25,7 +28,8 @@ Here are some tips for understanding Electron documentation syntax.
 
 ### Methods
 
-An example of [method](https://developer.mozilla.org/en-US/docs/Glossary/Method) documentation:
+An example of [method](https://developer.mozilla.org/en-US/docs/Glossary/Method)
+documentation:
 
 ---
 
@@ -36,13 +40,18 @@ An example of [method](https://developer.mozilla.org/en-US/docs/Glossary/Method)
 
 ---
 
-The method name is followed by the arguments it takes. Optional arguments are notated by brackets surrounding the optional argument as well as the comma required if this optional argument follows another argument.
+The method name is followed by the arguments it takes. Optional arguments are
+notated by brackets surrounding the optional argument as well as the comma
+required if this optional argument follows another argument.
 
-Below the method is more detailed information on each of the arguments. The type of argument is notated by either the common types: [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object), [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) or a custom type like Electron's [`webContent`](api/web-content.md).
+Below the method is more detailed information on each of the arguments. The type
+of argument is notated by either the common types: [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object), [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)
+or a custom type like Electron's [`webContent`](api/web-content.md).
 
 ### Events
 
-An example of [event](https://developer.mozilla.org/en-US/docs/Web/API/Event) documentation:
+An example of [event](https://developer.mozilla.org/en-US/docs/Web/API/Event)
+documentation:
 
 ---
 
@@ -54,7 +63,9 @@ Returns:
 
 ---
 
-The event is a string that is used after a `.on` listener method. If it returns a value it and its type is noted below. If you were to listen and respond to this event it might look something like this:
+The event is a string that is used after a `.on` listener method. If it returns
+a value it and its type is noted below. If you were to listen and respond to
+this event it might look something like this:
 
 ```javascript
 Alarm.on('wake-up', function(time) {

From d87c8a829141d06477986448f328dcb87a8bc7a1 Mon Sep 17 00:00:00 2001
From: Jessica Lord <jlord@github.com>
Date: Mon, 24 Aug 2015 14:56:19 +0200
Subject: [PATCH 07/12] Add optional notation

---
 docs/api/app.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/api/app.md b/docs/api/app.md
index a79b84a285a..4ca67225b3f 100644
--- a/docs/api/app.md
+++ b/docs/api/app.md
@@ -285,7 +285,7 @@ correctly.
 
 ### app.dock.bounce([type])
 
-* `type` String - Can be `critical` or `informational`. The default is
+* `type` String (optional) - Can be `critical` or `informational`. The default is
  `informational`
 
 When `critical` is passed, the dock icon will bounce until either the

From 5018fe1e1737513f679df96075dd0dd5a44e577c Mon Sep 17 00:00:00 2001
From: Jessica Lord <jlord@github.com>
Date: Mon, 24 Aug 2015 15:14:13 -0700
Subject: [PATCH 08/12] Revert "Add links to docs translations"

This reverts commit d7fda9c8cc93cbc5bbe5863d93ad187a8a6fd421.
---
 docs/README.md | 6 ------
 1 file changed, 6 deletions(-)

diff --git a/docs/README.md b/docs/README.md
index a16113864d2..d61df787c9d 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -66,9 +66,3 @@ Modules for both processes:
 * [Build instructions (Windows)](development/build-instructions-windows.md)
 * [Build instructions (Linux)](development/build-instructions-linux.md)
 * [Setting up symbol server in debugger](development/setting-up-symbol-server.md)
-
-## Documentation Translations
-
-- [Korean](https://github.com/atom/electron/tree/master/docs-translations/ko)
-- [Japanese](https://github.com/atom/electron/tree/master/docs-translations/jp)
-- [Spanish](https://github.com/atom/electron/tree/master/docs-translations/es)

From f74ce9cc1cd47f3617170227606b624fec262029 Mon Sep 17 00:00:00 2001
From: Jessica Lord <jlord@github.com>
Date: Mon, 24 Aug 2015 15:18:40 -0700
Subject: [PATCH 09/12] Add items to style guide list

---
 docs/styleguide.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/docs/styleguide.md b/docs/styleguide.md
index e10cfc3313e..9a81771598d 100644
--- a/docs/styleguide.md
+++ b/docs/styleguide.md
@@ -14,13 +14,17 @@ These are the ways that we construct the Electron documentation.
   - Hyphen separated filenames, however, are fine.
 - No headers following headers, add at least a one-sentence description.
 - Methods headers are wrapped in `code` ticks.
-- Event headers are wrapped in singe 'quotation' marks.
+- Event headers are wrapped in single 'quotation' marks.
 - No nesting lists more than 2 levels (unfortunately because of markdown
   renderer).
 - Add section titles: Events, Class Methods and Instance Methods.
 - Use 'will' over 'would' when describing outcomes.
 - Events and methods are `h3` headers.
 - Optional arguments written as `function (required[, optional])`.
+- Optional arguments are denoted when called out in list.
+- Line length is 80-column wrapped.
+- Platform specific methods are noted in italics following method header.
+ - ```### `method(foo, bar)` _Mac_```
 
 ## Reading Electron Documentation
 

From 7f72207e6636c39b8485716689fab125b5513f37 Mon Sep 17 00:00:00 2001
From: Jessica Lord <jlord@github.com>
Date: Mon, 24 Aug 2015 15:33:07 -0700
Subject: [PATCH 10/12] Add platform label where applicable

---
 docs/api/app.md | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/docs/api/app.md b/docs/api/app.md
index 4ca67225b3f..7e5ec57d5a4 100644
--- a/docs/api/app.md
+++ b/docs/api/app.md
@@ -245,7 +245,7 @@ bar, and on OS X you can visit it from dock menu.
 
 Clears the recent documents list.
 
-### `app.setUserTasks(tasks)`
+### `app.setUserTasks(tasks)` _Windows_
 
 * `tasks` Array - Array of `Task` objects
 
@@ -283,7 +283,7 @@ correctly.
 
 **Note:** This will not affect `process.argv`.
 
-### app.dock.bounce([type])
+### `app.dock.bounce([type])` _OS X_
 
 * `type` String (optional) - Can be `critical` or `informational`. The default is
  `informational`
@@ -299,7 +299,7 @@ Returns an ID representing the request.
 
 **Note:** This API is only available on OS X.
 
-### `app.dock.cancelBounce(id)`
+### `app.dock.cancelBounce(id)` _OS X_
 
 * `id` Integer
 
@@ -307,7 +307,7 @@ Cancel the bounce of `id`.
 
 **Note:** This API is only available on OS X.
 
-### `app.dock.setBadge(text)`
+### `app.dock.setBadge(text)` _OS X_
 
 * `text` String
 
@@ -315,25 +315,25 @@ Sets the string to be displayed in the dock’s badging area.
 
 **Note:** This API is only available on OS X.
 
-### `app.dock.getBadge()`
+### `app.dock.getBadge()` _OS X_
 
 Returns the badge string of the dock.
 
 **Note:** This API is only available on OS X.
 
-### `app.dock.hide()`
+### `app.dock.hide()` _OS X_
 
 Hides the dock icon.
 
 **Note:** This API is only available on OS X.
 
-### `app.dock.show()`
+### `app.dock.show()` _OS X_
 
 Shows the dock icon.
 
 **Note:** This API is only available on OS X.
 
-### `app.dock.setMenu(menu)`
+### `app.dock.setMenu(menu)` _OS X_
 
 * `menu` Menu
 

From 28a4069520c2ca8f753ab74fc44e436943db3303 Mon Sep 17 00:00:00 2001
From: Jessica Lord <jlord@github.com>
Date: Tue, 25 Aug 2015 10:05:48 -0700
Subject: [PATCH 11/12] =?UTF-8?q?Mac=20=E2=86=92=20OS=20X?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/styleguide.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/styleguide.md b/docs/styleguide.md
index 9a81771598d..23c590e6421 100644
--- a/docs/styleguide.md
+++ b/docs/styleguide.md
@@ -24,7 +24,7 @@ These are the ways that we construct the Electron documentation.
 - Optional arguments are denoted when called out in list.
 - Line length is 80-column wrapped.
 - Platform specific methods are noted in italics following method header.
- - ```### `method(foo, bar)` _Mac_```
+ - ```### `method(foo, bar)` _OS X_```
 
 ## Reading Electron Documentation
 

From aeb37941bb32d6c28723e4d50947e9f36c300fdf Mon Sep 17 00:00:00 2001
From: Jessica Lord <jlord@github.com>
Date: Tue, 25 Aug 2015 10:12:21 -0700
Subject: [PATCH 12/12] Replace platform notes with one general note

---
 docs/api/app.md | 17 ++---------------
 1 file changed, 2 insertions(+), 15 deletions(-)

diff --git a/docs/api/app.md b/docs/api/app.md
index 7e5ec57d5a4..db34d37ec59 100644
--- a/docs/api/app.md
+++ b/docs/api/app.md
@@ -152,6 +152,8 @@ Emitted when the gpu process crashes.
 
 The `app` object has the following methods:
 
+**Note** Some methods are only available on specific operating systems and are labeled as such.
+
 ### `app.quit()`
 
 Try to close all windows. The `before-quit` event will emitted first. If all
@@ -267,7 +269,6 @@ Adds `tasks` to the [Tasks][tasks] category of the JumpList on Windows.
   consists of two or more icons, set this value to identify the icon. If an
   icon file consists of one icon, this value is 0.
 
-**Note:** This API is only available on Windows.
 
 ### `app.commandLine.appendSwitch(switch[, value])`
 
@@ -297,49 +298,35 @@ or the request is canceled.
 
 Returns an ID representing the request.
 
-**Note:** This API is only available on OS X.
-
 ### `app.dock.cancelBounce(id)` _OS X_
 
 * `id` Integer
 
 Cancel the bounce of `id`.
 
-**Note:** This API is only available on OS X.
-
 ### `app.dock.setBadge(text)` _OS X_
 
 * `text` String
 
 Sets the string to be displayed in the dock’s badging area.
 
-**Note:** This API is only available on OS X.
-
 ### `app.dock.getBadge()` _OS X_
 
 Returns the badge string of the dock.
 
-**Note:** This API is only available on OS X.
-
 ### `app.dock.hide()` _OS X_
 
 Hides the dock icon.
 
-**Note:** This API is only available on OS X.
-
 ### `app.dock.show()` _OS X_
 
 Shows the dock icon.
 
-**Note:** This API is only available on OS X.
-
 ### `app.dock.setMenu(menu)` _OS X_
 
 * `menu` Menu
 
 Sets the application's [dock menu][dock-menu].
 
-**Note:** This API is only available on OS X.
-
 [dock-menu]:https://developer.apple.com/library/mac/documentation/Carbon/Conceptual/customizing_docktile/concepts/dockconcepts.html#//apple_ref/doc/uid/TP30000986-CH2-TPXREF103
 [tasks]:http://msdn.microsoft.com/en-us/library/windows/desktop/dd378460(v=vs.85).aspx#tasks