electron/docs/README.md

## Guides

* [Application distribution](tutorial/application-distribution.md)
* [Application packaging](tutorial/application-packaging.md)
* [Using native node modules](tutorial/using-native-node-modules.md)
* [Debugging main process](tutorial/debugging-main-process.md)
* [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md)
* [DevTools extension](tutorial/devtools-extension.md)

## Tutorials

* [Quick start](tutorial/quick-start.md)
* [Desktop environment integration](tutorial/desktop-environment-integration.md)
* [Online/offline event detection](tutorial/online-offline-events.md)

## API references

* [Synopsis](api/synopsis.md)
* [Process object](api/process.md)
* [Supported Chrome command line switches](api/chrome-command-line-switches.md)

Custom DOM elements:

* [`File` object](api/file-object.md)
* [`<webview>` tag](api/web-view-tag.md)
* [`window.open` function](api/window-open.md)

Modules for the main process:

* [app](api/app.md)
* [auto-updater](api/auto-updater.md)
* [browser-window](api/browser-window.md)
* [content-tracing](api/content-tracing.md)
* [dialog](api/dialog.md)
* [global-shortcut](api/global-shortcut.md)
* [ipc (main process)](api/ipc-main-process.md)
* [menu](api/menu.md)
* [menu-item](api/menu-item.md)
* [power-monitor](api/power-monitor.md)
* [protocol](api/protocol.md)
* [tray](api/tray.md)

Modules for the renderer process (web page):

* [ipc (renderer)](api/ipc-renderer.md)
* [remote](api/remote.md)
* [web-frame](api/web-frame.md)

Modules for both processes:

* [clipboard](api/clipboard.md)
* [crash-reporter](api/crash-reporter.md)
* [native-image](api/native-image.md)
* [screen](api/screen.md)
* [shell](api/shell.md)

## Development

* [Coding style](development/coding-style.md)
* [Source code directory structure](development/source-code-directory-structure.md)
* [Technical differences to NW.js (formerly node-webkit)](development/atom-shell-vs-node-webkit.md)
* [Build system overview](development/build-system-overview.md)
* [Build instructions (Mac)](development/build-instructions-mac.md)
* [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)
docs: Separate guides and tutorials 2015-03-17 18:37:18 +08:00			`## Guides`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
:memo: Separate the application distribution chapter out. 2014-05-04 18:32:12 +08:00			`* [Application distribution](tutorial/application-distribution.md)`
docs: Add reference on app packaging 2014-09-29 21:34:54 +08:00			`* [Application packaging](tutorial/application-packaging.md)`
docs: use => using 2014-09-13 00:14:24 +08:00			`* [Using native node modules](tutorial/using-native-node-modules.md)`
Renamed browser-side to main process renamed a few occurances of "web page" to "renderer" renamed a few files that had "browser" in their name to "main-process" note that there are still many occurances of web page. 2015-03-26 10:20:31 -05:00			`* [Debugging main process](tutorial/debugging-main-process.md)`
docs: use => using 2014-09-13 00:14:24 +08:00			`* [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md)`
docs: Add docs on how to use chrome devtools extension. 2014-08-28 16:33:27 +08:00			`* [DevTools extension](tutorial/devtools-extension.md)`
docs: Separate guides and tutorials 2015-03-17 18:37:18 +08:00
docs: Add a "s" 2015-03-19 11:25:53 +08:00			`## Tutorials`
docs: Separate guides and tutorials 2015-03-17 18:37:18 +08:00
docs: "Quick start" should also be a "tutorial" Guides should include information that not available in the API references, and tutorials should be step-by-step walkthrough or introductory text on certain APIs. 2015-03-17 18:41:54 +08:00			`* [Quick start](tutorial/quick-start.md)`
docs: Separate guides and tutorials 2015-03-17 18:37:18 +08:00			`* [Desktop environment integration](tutorial/desktop-environment-integration.md)`
Add tutorial on online/offline event detection 2014-11-05 07:47:38 -07:00			`* [Online/offline event detection](tutorial/online-offline-events.md)`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
:memo: Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00			`## API references`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
:memo: Add Synopsis chapter. 2014-05-05 14:49:05 +08:00			`* [Synopsis](api/synopsis.md)`
:memo: Mention atom-shell's changes to the process object. 2014-05-23 22:56:56 +08:00			`* [Process object](api/process.md)`
docs: Document the chrome command switches we support. 2014-08-15 13:06:52 +08:00			`* [Supported Chrome command line switches](api/chrome-command-line-switches.md)`
:memo: Add Synopsis chapter. 2014-05-05 14:49:05 +08:00
Add docs on our custom web elements 2014-10-25 14:58:32 +08:00			`Custom DOM elements:`

fix broken links 2014-10-27 22:43:29 +01:00			* [`File` object](api/file-object.md)
			* [`<webview>` tag](api/web-view-tag.md)
docs: Put window.open docs in its own chapter, regards #1137 2015-03-04 08:47:04 -08:00			* [`window.open` function](api/window-open.md)
Add docs on our custom web elements 2014-10-25 14:58:32 +08:00
Renamed browser-side to main process renamed a few occurances of "web page" to "renderer" renamed a few files that had "browser" in their name to "main-process" note that there are still many occurances of web page. 2015-03-26 10:20:31 -05:00			`Modules for the main process:`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
:memo: Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00			`* [app](api/app.md)`
			`* [auto-updater](api/auto-updater.md)`
			`* [browser-window](api/browser-window.md)`
Add docs on content-tracing module. 2014-07-31 15:40:40 +08:00			`* [content-tracing](api/content-tracing.md)`
:memo: Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00			`* [dialog](api/dialog.md)`
docs: Sort modules in alphabet sequence. 2014-08-05 00:05:26 +08:00			`* [global-shortcut](api/global-shortcut.md)`
Renamed browser-side to main process renamed a few occurances of "web page" to "renderer" renamed a few files that had "browser" in their name to "main-process" note that there are still many occurances of web page. 2015-03-26 10:20:31 -05:00			`* [ipc (main process)](api/ipc-main-process.md)`
:memo: Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00			`* [menu](api/menu.md)`
			`* [menu-item](api/menu-item.md)`
			`* [power-monitor](api/power-monitor.md)`
			`* [protocol](api/protocol.md)`
:memo: Document the tray module. 2014-06-02 11:47:22 +08:00			`* [tray](api/tray.md)`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
Renamed browser-side to main process renamed a few occurances of "web page" to "renderer" renamed a few files that had "browser" in their name to "main-process" note that there are still many occurances of web page. 2015-03-26 10:20:31 -05:00			`Modules for the renderer process (web page):`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
:memo: Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00			`* [ipc (renderer)](api/ipc-renderer.md)`
			`* [remote](api/remote.md)`
Rename web-view module to web-frame 2014-10-24 18:24:12 +08:00			`* [web-frame](api/web-frame.md)`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
Renamed browser-side to main process renamed a few occurances of "web page" to "renderer" renamed a few files that had "browser" in their name to "main-process" note that there are still many occurances of web page. 2015-03-26 10:20:31 -05:00			`Modules for both processes:`
Move wiki content to docs dir 2013-08-14 15:43:35 -07:00
:memo: Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00			`* [clipboard](api/clipboard.md)`
			`* [crash-reporter](api/crash-reporter.md)`
docs: Use NativeImage to replace Image 2015-02-12 13:52:28 +08:00			`* [native-image](api/native-image.md)`
:memo: Simpilify the structure of API references. 2014-05-05 14:24:57 +08:00			`* [screen](api/screen.md)`
			`* [shell](api/shell.md)`
:memo: Add Synopsis chapter. 2014-05-05 14:49:05 +08:00
			`## Development`

			`* [Coding style](development/coding-style.md)`
			`* [Source code directory structure](development/source-code-directory-structure.md)`
:memo: avoid breaking everyone's stuff 2015-03-16 16:50:23 +05:30			`* [Technical differences to NW.js (formerly node-webkit)](development/atom-shell-vs-node-webkit.md)`
docs: Add "Build system overview" chapter 2015-04-11 12:11:40 +08:00			`* [Build system overview](development/build-system-overview.md)`
:memo: Add Synopsis chapter. 2014-05-05 14:49:05 +08:00			`* [Build instructions (Mac)](development/build-instructions-mac.md)`
			`* [Build instructions (Windows)](development/build-instructions-windows.md)`
			`* [Build instructions (Linux)](development/build-instructions-linux.md)`
docs: Setting up symbol server in debugger 2014-11-10 16:09:13 +08:00			`* [Setting up symbol server in debugger](development/setting-up-symbol-server.md)`