diff --git a/docs/README.md b/docs/README.md index d29a8316b3..0c56b176f0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -18,6 +18,7 @@ an issue: ## Guides and Tutorials +* [About Electron](tutorial/about.md) * [Setting up the Development Environment](tutorial/development-environment.md) * [Setting up macOS](tutorial/development-environment.md#setting-up-macos) * [Setting up Windows](tutorial/development-environment.md#setting-up-windows) @@ -40,7 +41,7 @@ an issue: * [Using Native Node.js Modules](tutorial/using-native-node-modules.md) * Adding Features to Your App * [Notifications](tutorial/notifications.md) - * [Recent Documents](tutorial/desktop-environment-integration.md#recent-documents) + * [Recent Documents](tutorial/recent-documents.md) * [Application Progress](tutorial/progress-bar.md) * [Custom Dock Menu](tutorial/macos-dock.md) * [Custom Windows Taskbar](tutorial/windows-taskbar.md) @@ -49,12 +50,15 @@ an issue: * [Offline/Online Detection](tutorial/online-offline-events.md) * [Represented File for macOS BrowserWindows](tutorial/represented-file.md) * [Native File Drag & Drop](tutorial/native-file-drag-drop.md) + * [Offscreen Rendering](tutorial/offscreen-rendering.md) + * [Supporting macOS Dark Mode](tutorial/mojave-dark-mode-guide.md) * [Accessibility](tutorial/accessibility.md) * [Spectron](tutorial/accessibility.md#spectron) * [Devtron](tutorial/accessibility.md#devtron) * [Enabling Accessibility](tutorial/accessibility.md#enabling-accessibility) * [Testing and Debugging](tutorial/application-debugging.md) * [Debugging the Main Process](tutorial/debugging-main-process.md) + * [Debugging the Main Process with Visual Studio Code](tutorial/debugging-main-process-vscode.md) * [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md) * [Testing on Headless CI Systems (Travis, Jenkins)](tutorial/testing-on-headless-ci.md) * [DevTools Extension](tutorial/devtools-extension.md) @@ -75,27 +79,27 @@ an issue: * [Deploying an Update Server](tutorial/updates.md#deploying-an-update-server) * [Implementing Updates in Your App](tutorial/updates.md#implementing-updates-in-your-app) * [Applying Updates](tutorial/updates.md#applying-updates) +* [Getting Support](tutorial/support.md) ## Detailed Tutorials These individual tutorials expand on topics discussed in the guide above. -* [In Detail: Installing Electron](tutorial/installation.md) +* [Installing Electron](tutorial/installation.md) * [Proxies](tutorial/installation.md#proxies) * [Custom Mirrors and Caches](tutorial/installation.md#custom-mirrors-and-caches) * [Troubleshooting](tutorial/installation.md#troubleshooting) -* [In Detail: Electron's Versioning Scheme](tutorial/electron-versioning.md) - * [semver](tutorial/electron-versioning.md#semver) - * [Stabilization Branches](tutorial/electron-versioning.md#stabilization-branches) - * [Beta Releases and Bug Fixes](tutorial/electron-versioning.md#beta-releases-and-bug-fixes) -* [In Detail: Packaging App Source Code with asar](tutorial/application-packaging.md) +* Electron Releases & Developer Feedback + * [Versioning Policy](tutorial/electron-versioning.md) + * [Release Timelines](tutorial/electron-timelines.md) + * [App Feedback Program](tutorial/app-feedback-program.md) +* [Packaging App Source Code with asar](tutorial/application-packaging.md) * [Generating asar Archives](tutorial/application-packaging.md#generating-asar-archives) * [Using asar Archives](tutorial/application-packaging.md#using-asar-archives) * [Limitations](tutorial/application-packaging.md#limitations-of-the-node-api) * [Adding Unpacked Files to asar Archives](tutorial/application-packaging.md#adding-unpacked-files-to-asar-archives) -* [In Detail: Testing Widevine CDM](tutorial/testing-widevine-cdm.md) -* [In Detail: Using Pepper Flash Plugin](tutorial/using-pepper-flash-plugin.md) -* [Offscreen Rendering](tutorial/offscreen-rendering.md) +* [Testing Widevine CDM](tutorial/testing-widevine-cdm.md) +* [Using Pepper Flash Plugin](tutorial/using-pepper-flash-plugin.md) --- @@ -114,6 +118,7 @@ These individual tutorials expand on topics discussed in the guide above. * [`File` Object](api/file-object.md) * [`` Tag](api/webview-tag.md) * [`window.open` Function](api/window-open.md) +* [`BrowserWindowProxy` Object](api/browser-window-proxy.md) ### Modules for the Main Process: @@ -133,8 +138,10 @@ These individual tutorials expand on topics discussed in the guide above. * [powerMonitor](api/power-monitor.md) * [powerSaveBlocker](api/power-save-blocker.md) * [protocol](api/protocol.md) +* [screen](api/screen.md) * [session](api/session.md) * [systemPreferences](api/system-preferences.md) +* [TouchBar](api/touch-bar.md) * [Tray](api/tray.md) * [webContents](api/web-contents.md) @@ -150,7 +157,6 @@ These individual tutorials expand on topics discussed in the guide above. * [clipboard](api/clipboard.md) * [crashReporter](api/crash-reporter.md) * [nativeImage](api/native-image.md) -* [screen](api/screen.md) * [shell](api/shell.md) ## Development diff --git a/docs/tutorial/app-feedback-program.md b/docs/tutorial/app-feedback-program.md index 6cb9e91dde..862dec5de9 100644 --- a/docs/tutorial/app-feedback-program.md +++ b/docs/tutorial/app-feedback-program.md @@ -1,2 +1,3 @@ # Electron App Feedback Program + Electron is working on building a streamlined release process and having faster releases. To help with that, we have the App Feedback Program for large-scale Electron apps to test our beta releases and report app-specific issues to the Electron team. We use this program to help us prioritize work and get applications upgraded to the next stable release as soon as possible. There are a few requirements we expect from participants, such as attending short, online weekly check-ins. Please visit the [blog post](https://electronjs.org/blog/app-feedback-program) for details and sign-up. diff --git a/docs/tutorial/electron-timelines.md b/docs/tutorial/electron-timelines.md index bceab23434..a07126c882 100644 --- a/docs/tutorial/electron-timelines.md +++ b/docs/tutorial/electron-timelines.md @@ -1,10 +1,13 @@ # Electron Release Timelines -### Notes: + +### Notes + * The `-beta.1` and `stable` dates are our *concrete* release dates. * We strive for weekly beta releases, however we often release more betas than scheduled. * All dates are our goals but there may be reasons for adjusting the stable deadline, such as security bugs. ## 5.0.0 Release Schedule + *Includes: Chromium M73 and Node v12.0* Take a look at 5.0.0 Timeline [blog post](https://electronjs.org/blog/electron-5-0-timeline) for info about publicizing our release dates. @@ -47,4 +50,5 @@ Take a look at 5.0.0 Timeline [blog post](https://electronjs.org/blog/electron-5 | Tue, 2019-Jul-30 | 6.0.0 | ✨ stable ✨ | ## 7.0.0 Release Schedule + TBD