From 975e6e6194309875f4dc2e7a27aad10d1eb19643 Mon Sep 17 00:00:00 2001 From: Felix Rieseberg Date: Tue, 20 Feb 2018 09:47:18 -0600 Subject: [PATCH] :heart: First round of feedback --- docs/README.md | 8 ++++---- docs/tutorial/application-architecture.md | 3 ++- docs/tutorial/boilerplates-and-clis.md | 7 ++++--- .../{unity-launcher.md => linux-desktop-actions.md} | 9 ++++++--- 4 files changed, 16 insertions(+), 11 deletions(-) rename docs/tutorial/{unity-launcher.md => linux-desktop-actions.md} (70%) diff --git a/docs/README.md b/docs/README.md index bc5b3346b785..d7ab466dcec7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -37,16 +37,16 @@ an issue: * [Using Node.js APIs](tutorial/application-architecture.md#using-node.js-apis) * [Using Native Node.js Modules](tutorial/using-native-node-modules.md) * [Inter-Process Communication](tutorial/application-architecture.md#) -* [Adding Features to Your App]() +* Adding Features to Your App * [Notifications](tutorial/notifications.md) * [Recent Documents](tutorial/desktop-environment-integration.md#recent-documents-windows-mac-os) * [Application Progress](tutorial/progress-bar.md) * [Custom Dock Menu](tutorial/desktop-environment-integration.md#custom-dock-menu-mac-os) * [Custom Windows Taskbar](tutorial/windows-taskbar.md) - * [Custom Unity Launcher](tutorial/unity-launcher.md) + * [Custom Linux Desktop Actions](tutorial/linux-desktop-actions.md) * [Keyboard Shortcuts](tutorial/keyboard-shortcuts.md) * [Offline/Online Detection](tutorial/online-offline-events.md) - * [Represented File for macOS Windows](tutorial/represented-file.md) + * [Represented File for macOS BrowserWindows](tutorial/represented-file.md) * [Native File Drag & Drop](tutorial/native-file-drag-drop.md) * [Application Accessibility](tutorial/accessibility.md) * [Spectron](tutorial/accessibility.md#spectron) @@ -94,7 +94,7 @@ These individual tutorial expand on topics discussed in the guide above. * [In Detail: Using Widevine CDM Plugin](tutorial/using-widevine-cdm-plugin.md) * [Offscreen Rendering](tutorial/offscreen-rendering.md) -____ +--- * [Glossary of Terms](glossary.md) diff --git a/docs/tutorial/application-architecture.md b/docs/tutorial/application-architecture.md index 31c8c24e7f63..12d11be009a4 100644 --- a/docs/tutorial/application-architecture.md +++ b/docs/tutorial/application-architecture.md @@ -131,7 +131,7 @@ There is one important caveat: Native Node.js modules (that is, modules that require compilation of native code before they can be used) will need to be compiled to be used with Electron. -The vast majority of Node.js modules is _not_ native. Only 400 out of the +The vast majority of Node.js modules are _not_ native. Only 400 out of the ~650.000 modules are native. However, if you do need native modules, please consult [this guide on how to recompile them for Electron][native-node] (it's easy). @@ -139,3 +139,4 @@ easy). [node-docs]: https://nodejs.org/en/docs/ [security]: ./security.md [native-node]: ./using-native-node-modules.md +[share-data]: ../faq.md#how-to-share-data-between-web-pages diff --git a/docs/tutorial/boilerplates-and-clis.md b/docs/tutorial/boilerplates-and-clis.md index ea71412cbeb6..455ae65f4f23 100644 --- a/docs/tutorial/boilerplates-and-clis.md +++ b/docs/tutorial/boilerplates-and-clis.md @@ -33,8 +33,8 @@ development. Forge comes with [ready-to-use templates][forge-templates] for popular frameworks like React, Vue, or Angular. It uses the same core modules used by the -greater Electron community (like [`electron-packager`]) – changes made by -Electron maintainers (like Slack) benefit Forge's users, too. +greater Electron community (like [`electron-packager`][electron-packager]) –  +changes made by Electron maintainers (like Slack) benefit Forge's users, too. You can find more information and documentation on [electronforge.io][forge]. @@ -59,7 +59,7 @@ CT Lin's [`electron-react-boilerplate`][boilerplate] might be worth a look. It's quite popular in the community and uses `electron-builder` internally. -## Other Tools and Bboilerplates +## Other Tools and Boilerplates The ["Awesome Electron" list][awesome] contains more tools and boilerplates to choose from. If you find the length of the list intimidating, don't @@ -69,5 +69,6 @@ forget that adding tools as you go along is a valid approach, too. [forge]: https://electronforge.io/ [forge-templates]: https://electronforge.io/templates [builder]: https://github.com/electron-userland/electron-builder +[electron-packager]: https://github.com/electron-userland/electron-packager [boilerplate]: https://github.com/chentsulin/electron-react-boilerplate [awesome]: https://github.com/sindresorhus/awesome-electron#boilerplates diff --git a/docs/tutorial/unity-launcher.md b/docs/tutorial/linux-desktop-actions.md similarity index 70% rename from docs/tutorial/unity-launcher.md rename to docs/tutorial/linux-desktop-actions.md index dd0148f12d82..bf5a14d15acd 100644 --- a/docs/tutorial/unity-launcher.md +++ b/docs/tutorial/linux-desktop-actions.md @@ -1,7 +1,9 @@ -# Unity Launcher Shortcuts +# Custom Linux Desktop Launcher Actions -In Unity, you can add custom entries to its launcher via modifying the -`.desktop` file, see [Adding Shortcuts to a Launcher][unity-launcher]. +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]. __Launcher shortcuts of Audacious:__ @@ -36,3 +38,4 @@ parameters. You can find these in your app in the global variable [unity-launcher]: https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles#Adding_shortcuts_to_a_launcher [audacious-launcher]: https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles?action=AttachFile&do=get&target=shortcuts.png +[spec]: https://specifications.freedesktop.org/desktop-entry-spec/1.1/ar01s11.html \ No newline at end of file