8000 [GSoD] docs: Added revised version of the quick start guide by bandantonio · Pull Request #25760 · electron/electron · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[GSoD] docs: Added revised version of the quick start guide #25760

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Oct 13, 2020
16 changes: 8 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,20 @@ an issue:
* [Setting up Windows](tutorial/development-environment.md#setting-up-windows)
* [Setting up Linux](tutorial/development-environment.md#setting-up-linux)
* [Choosing an Editor](tutorial/development-environment.md#a-good-editor)
* [Creating your First App](tutorial/first-app.md)
* [Installing Electron](tutorial/first-app.md#installing-electron)
* [Electron Development in a Nutshell](tutorial/first-app.md#electron-development-in-a-nutshell)
* [Running Your App](tutorial/first-app.md#running-your-app)
* [Creating your First App](tutorial/quick-start.md)
* [Prerequisites](tutorial/quick-start.md#prerequisites)
* [Create a basic application](tutorial/quick-start.md#create-a-basic-application)
* [Package and distribute the application](tutorial/quick-start.md#package-and-distribute-the-application)
* [Boilerplates and CLIs](tutorial/boilerplates-and-clis.md)
* [Boilerplate vs CLI](tutorial/boilerplates-and-clis.md#boilerplate-vs-cli)
* [electron-forge](tutorial/boilerplates-and-clis.md#electron-forge)
* [electron-builder](tutorial/boilerplates-and-clis.md#electron-builder)
* [electron-react-boilerplate](tutorial/boilerplates-and-clis.md#electron-react-boilerplate)
* [Other Tools and Boilerplates](tutorial/boilerplates-and-clis.md#other-tools-and-boilerplates)
* [Application Architecture](tutorial/application-architecture.md)
* [Main and Renderer Processes](tutorial/application-architecture.md#main-and-renderer-processes)
* [Using Electron's APIs](tutorial/application-architecture.md#using-electron-apis)
* [Using Node.js APIs](tutorial/application-architecture.md#using-nodejs-apis)
* [Application Architecture](tutorial/quick-start.md#application-architecture)
* [Main and Renderer Processes](tutorial/quick-start.md#main-and-renderer-processes)
* [Electron API](tutorial/quick-start.md#electron-api)
* [Node.js API](tutorial/quick-start.md#nodejs-api)
* [Using Native Node.js Modules](tutorial/using-native-node-modules.md)
* [Performance Strategies](tutorial/performance.md)
* Adding Features to Your App
Expand Down
4 changes: 2 additions & 2 deletions docs/api/synopsis.md
Original file line number Diff line numbe 10000 r Diff line change
Expand Up @@ -13,7 +13,7 @@ either process type.

The basic rule is: if a module is [GUI][gui] or low-level system related, then
it should be only available in the main process. You need to be familiar with
the concept of [main process vs. renderer process](../tutorial/application-architecture.md#main-and-renderer-processes)
the concept of [main process vs. renderer process](../tutorial/quick-start.md#main-and-renderer-processes)
scripts to be able to use those modules.

The main process script is like a normal Node.js script:
Expand Down Expand Up @@ -43,7 +43,7 @@ extra ability to use node modules if `nodeIntegration` is enabled:
</html>
```

To run your app, read [Run your app](../tutorial/first-app.md#running-your-app).
To run your app, read [Run your app](../tutorial/quick-start.md#run-your-application).

## Destructuring assignment

Expand Down
2 changes: 1 addition & 1 deletion docs/api/touch-bar-button.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Create a button in the touch bar for native macOS applications

Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
Process: [Main](../glossary.md#main-process)

### `new TouchBarButton(options)`

Expand Down
2 changes: 1 addition & 1 deletion docs/api/touch-bar-color-picker.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Create a color picker in the touch bar for native macOS applications

Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
Process: [Main](../glossary.md#main-process)

### `new TouchBarColorPicker(options)`

Expand Down
2 changes: 1 addition & 1 deletion docs/api/touch-bar-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Create a group in the touch bar for native macOS applications

Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
Process: [Main](../glossary.md#main-process)

### `new TouchBarGroup(options)`

Expand Down
2 changes: 1 addition & 1 deletion docs/api/touch-bar-label.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Create a label in the touch bar for native macOS applications

Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
Process: [Main](../glossary.md#main-process)

### `new TouchBarLabel(options)`

Expand Down
2 changes: 1 addition & 1 deletion docs/api/touch-bar-other-items-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@
>
> Note: Only one instance of this class can be added per TouchBar.

Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
Process: [Main](../glossary.md#main-process)

### `new TouchBarOtherItemsProxy()`
2 changes: 1 addition & 1 deletion docs/api/touch-bar-popover.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Create a popover in the touch bar for native macOS applications

Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
Process: [Main](../glossary.md#main-process)

### `new TouchBarPopover(options)`

Expand Down
2 changes: 1 addition & 1 deletion docs/api/touch-bar-scrubber.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Create a scrubber (a scrollable selector)

Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
Process: [Main](../glossary.md#main-process)

### `new TouchBarScrubber(options)`

Expand Down
2 changes: 1 addition & 1 deletion docs/api/touch-bar-segmented-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Create a segmented control (a button group) where one button has a selected state

Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
Process: [Main](../glossary.md#main-process)

### `new TouchBarSegmentedControl(options)`

Expand Down
2 changes: 1 addition & 1 deletion docs/api/touch-bar-slider.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Create a slider in the touch bar for native macOS applications

Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
Process: [Main](../glossary.md#main-process)

### `new TouchBarSlider(options)`

Expand Down
2 changes: 1 addition & 1 deletion docs/api/touch-bar-spacer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Create a spacer between two items in the touch bar for native macOS applications

Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
Process: [Main](../glossary.md#main-process)

### `new TouchBarSpacer(options)`

Expand Down
2 changes: 1 addition & 1 deletion docs/api/touch-bar.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> Create TouchBar layouts for native macOS applications

Process: [Main](../tutorial/application-architecture.md#main-and-renderer-processes)
Process: [Main](../glossary.md#main-process)

### `new TouchBar(options)`

Expand Down
Binary file added docs/images/simplest-electron-app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
147 changes: 0 additions & 147 deletions docs/tutorial/application-architecture.md

This file was deleted.

Loading
0