Erick Zhao
6330f8be9f
docs: rework introduction docs ( #29062 )
...
* docs: add 'introduction' doc
* note
* wip
* updates
* wip
* wip
* wip
* add missing code
* wip
* add image for chrome processes
* process model wip
* finish line?
* update links
* Update docs/README.md
Co-authored-by: Cheng Zhao <github@zcbenz.com>
* Update docs/tutorial/introduction.md
Co-authored-by: Mark Lee <malept@users.noreply.github.com>
* Update docs/tutorial/quick-start.md
Co-authored-by: Mark Lee <malept@users.noreply.github.com>
* Update docs/tutorial/process-model.md
Co-authored-by: Mark Lee <malept@users.noreply.github.com>
* Update docs/tutorial/process-model.md
Co-authored-by: Mark Lee <malept@users.noreply.github.com>
* Update docs/tutorial/process-model.md
Co-authored-by: Mark Lee <malept@users.noreply.github.com>
* Update docs/tutorial/quick-start.md
Co-authored-by: Mark Lee <malept@users.noreply.github.com>
* Update docs/tutorial/quick-start.md
Co-authored-by: Mark Lee <malept@users.noreply.github.com>
* Update docs/tutorial/quick-start.md
Co-authored-by: Mark Lee <malept@users.noreply.github.com>
* Update docs/tutorial/quick-start.md
Co-authored-by: Mark Lee <malept@users.noreply.github.com>
* address code review
* Update docs/tutorial/application-distribution.md
Co-authored-by: Mark Lee <malept@users.noreply.github.com>
* remove wip doc
Co-authored-by: Cheng Zhao <github@zcbenz.com>
Co-authored-by: Mark Lee <malept@users.noreply.github.com>
2021-05-24 11:32:36 +09:00
Antonio
8dfb1cf78f
docs: revised version of the quick start guide ( #25760 )
2020-10-13 13:15:40 -07:00
Jeremy Rose
5de7eb3618
docs: remove references to remote from docs ( #25416 )
2020-09-14 10:36:54 -07:00
Charles Kerr
c83f836faf
refactor: prefer using app.whenReady() ( #21972 )
...
* docs: add references to app.whenReady() in isReady
* refactor: prefer app.whenReady()
In the docs, specs, and lib, replace instances of `app.once('ready')`
(seen occasionally) and `app.on('ready')` (extremely common) with
`app.whenReady()`.
It's better to encourage users to use whenReady():
1. it handles the edge case of registering for 'ready' after it's fired
2. it avoids the minor wart of leaving an active listener alive for
an event that wll never fire again
2020-02-03 22:43:22 +00:00
Samuel Attard
558fff69e7
chore: update to standard 12
2018-09-14 14:57:01 +10:00
Charles Kerr
4d078fdb03
Remove more words ( #12852 )
...
* remove 'basically' from docs
* remove 'simply' from docs
* remove most uses of 'just' from docs
2018-05-08 00:16:09 -05:00
TiagoDanin
d7a003b0bc
📝 Fix dead urls
2018-04-09 17:58:10 -03:00
Long Nhat Nguyen
c017a7a1c7
Update url ( #7598 )
...
* Update EventEmitter URL
* Update EventEmitter URL
* Enable click
* Update EventEmitter URL
* Update EventEmitter URL
* Update URL
* Update URL
* Update EventEmitter URL
* Tweak sentence and add perios
2016-10-13 14:09:14 -07:00
Zeke Sikelianos
06a354a2eb
standardize all javascript blocks in English docs
2016-07-26 09:48:19 -07:00
Plusb Preco
3ee9eef308
📝 Remove unused link
...
[ci skip]
2016-05-19 18:34:08 +09:00
Cheng Zhao
0f52a6da39
Merge branch '1-0-release'
2016-05-11 15:14:56 +09:00
Plusb Preco
885aeec442
📝 Match variable names
...
[ci skip]
2016-05-11 02:16:32 +09:00
Plusb Preco
139a4f984a
📝 Add missing semicolons
...
[ci skip]
2016-05-11 01:57:55 +09:00
Plusb Preco
4d7296e1db
📝 Match destructuring style
...
[ci skip]
2016-05-11 01:26:38 +09:00
Cheng Zhao
28f1aef7b4
Remove ELECTRON_HIDE_INTERNAL_MODULES in docs
2016-05-06 10:12:56 -07:00
Steve Kinney
afe0296e0f
📝 Rewrite docs on destructuring assignment [ci skip]
2016-05-04 11:59:40 -06:00
Zeke Sikelianos
2c8261b429
update excerpts based on feedback
2016-04-22 10:32:28 -07:00
Zeke Sikelianos
0527b17e42
blockquote summaries
2016-04-22 10:32:28 -07:00
Zeke Sikelianos
ee190ca62a
create a one-liner description for each API
2016-04-22 10:32:28 -07:00
Plusb Preco
4f4277e25e
📝 Fix coding style issues
...
* Adjust line length to `80`
* Normalize whitespaces
[ci skip]
2016-04-22 22:54:43 +09:00
Kevin Sawicki
102f7e8e33
Update docs for new org
2016-04-04 12:05:53 -07:00
Dongjoon Hyun
f9f20957a4
Fix link name.
2016-03-05 23:28:39 -08:00
Andrew Zheng
b4aaaed843
Fix a broken link
...
The reference-style link uses a relative path, which doesn't work well on the main site http://electron.atom.io/ .
2016-01-18 13:50:33 -08:00
Clark Feusier
c6167bdf0a
Fix broken link in Docs > Synopsis
2015-12-04 21:51:33 -08:00
Cheng Zhao
5cacf79bc5
docs: Document the new style of remote module
2015-11-13 22:34:00 +08:00
Cheng Zhao
fbb8e61958
Replace "Url" in API names with "URL"
2015-11-13 16:03:40 +08:00
Cheng Zhao
c5913c3149
docs: Add notes on old APIs
2015-11-12 22:24:11 +08:00
Cheng Zhao
eac2e7cc61
docs: Update codes in docs to use require('electron')
2015-11-12 21:20:09 +08:00
Jessica Lord
b797804fd9
Use "in" over "on"
2015-09-04 13:44:40 -07:00
Jessica Lord
91c75d73dd
Text edits
2015-09-01 15:42:10 -07:00
Jessica Lord
e8a04981bb
Standardize synopsis
2015-08-28 22:46:31 -07:00
Sam Saccone
d91ddc6177
💄 Fix grammatical issue
2015-05-23 15:41:36 -04:00
Cheng Zhao
d2682233fd
docs: Atom Shell => Electron
2015-04-16 11:31:12 +08:00
Joseph Dykstra
b6875ad49b
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
Brian Boucheron
72d6a13e9e
Broken link in docs, api/synopsis
...
Link to using-native-node-modules.md instead of use-native-node-modules. Filename changed with 268508764f
2015-02-19 12:03:05 -05:00
Greg Mefford
9e0b1b864b
Doc: Grammatical fixes to synopsys.md
2014-05-09 21:17:10 -04:00
Cheng Zhao
5c55b9412f
📝 Add Synopsis chapter.
2014-05-05 14:49:05 +08:00