diff --git a/docs/api/system-preferences.md b/docs/api/system-preferences.md index 3936cd7c2f8d..20c330460ec8 100644 --- a/docs/api/system-preferences.md +++ b/docs/api/system-preferences.md @@ -433,7 +433,7 @@ It will always return `granted` for `screen` and for all media types on older ve Returns `Promise` - A promise that resolves with `true` if consent was granted and `false` if it was denied. If an invalid `mediaType` is passed, the promise will be rejected. If an access request was denied and later is changed through the System Preferences pane, a restart of the app will be required for the new permissions to take effect. If access has already been requested and denied, it _must_ be changed through the preference pane; an alert will not pop up and the promise will resolve with the existing access status. -**Important:** In order to properly leverage this API, you [must set](https://developer.apple.com/documentation/avfoundation/cameras_and_media_capture/requesting_authorization_for_media_capture_on_macos?language=objc) the `NSMicrophoneUsageDescription` and `NSCameraUsageDescription` strings in your app's `Info.plist` file. The values for these keys will be used to populate the permission dialogs so that the user will be properly informed as to the purpose of the permission request. See [Electron Application Distribution](https://electronjs.org/docs/tutorial/application-distribution#macos) for more information about how to set these in the context of Electron. +**Important:** In order to properly leverage this API, you [must set](https://developer.apple.com/documentation/avfoundation/cameras_and_media_capture/requesting_authorization_for_media_capture_on_macos?language=objc) the `NSMicrophoneUsageDescription` and `NSCameraUsageDescription` strings in your app's `Info.plist` file. The values for these keys will be used to populate the permission dialogs so that the user will be properly informed as to the purpose of the permission request. See [Electron Application Distribution](../tutorial/application-distribution.md#macos) for more information about how to set these in the context of Electron. This user consent was not required until macOS 10.14 Mojave, so this method will always return `true` if your system is running 10.13 High Sierra or lower. diff --git a/docs/development/pull-requests.md b/docs/development/pull-requests.md index 562ddfaa2b00..6179f46907a3 100644 --- a/docs/development/pull-requests.md +++ b/docs/development/pull-requests.md @@ -36,9 +36,9 @@ $ git fetch upstream Build steps and dependencies differ slightly depending on your operating system. See these detailed guides on building Electron locally: -* [Building on macOS](https://electronjs.org/docs/development/build-instructions-macos) -* [Building on Linux](https://electronjs.org/docs/development/build-instructions-linux) -* [Building on Windows](https://electronjs.org/docs/development/build-instructions-windows) +* [Building on macOS](build-instructions-macos.md) +* [Building on Linux](build-instructions-linux.md) +* [Building on Windows](build-instructions-windows.md) Once you've built the project locally, you're ready to start making changes! @@ -63,7 +63,7 @@ or tests in the `spec/` folder. Please be sure to run `npm run lint` from time to time on any code changes to ensure that they follow the project's code style. -See [coding style](https://electronjs.org/docs/development/coding-style) for +See [coding style](coding-style.md) for more information about best practice when modifying code in different parts of the project. @@ -144,7 +144,7 @@ master. ### Step 7: Test Bug fixes and features should always come with tests. A -[testing guide](https://electronjs.org/docs/development/testing) has been +[testing guide](testing.md) has been provided to make the process easier. Looking at other tests to see how they should be structured can also help. diff --git a/docs/tutorial/application-debugging.md b/docs/tutorial/application-debugging.md index 0f4315632821..c9619e37779a 100644 --- a/docs/tutorial/application-debugging.md +++ b/docs/tutorial/application-debugging.md @@ -43,6 +43,6 @@ If the V8 context crashes, the DevTools will display this message. `DevTools was disconnected from the page. Once page is reloaded, DevTools will automatically reconnect.` -Chromium logs can be enabled via the `ELECTRON_ENABLE_LOGGING` environment variable. For more information, see the [environment variables documentation](https://www.electronjs.org/docs/api/environment-variables#electron_enable_logging). +Chromium logs can be enabled via the `ELECTRON_ENABLE_LOGGING` environment variable. For more information, see the [environment variables documentation](../api/environment-variables.md#electron_enable_logging). -Alternatively, the command line argument `--enable-logging` can be passed. More information is available in the [command line switches documentation](https://www.electronjs.org/docs/api/command-line-switches#--enable-logging). +Alternatively, the command line argument `--enable-logging` can be passed. More information is available in the [command line switches documentation](../api/command-line-switches.md#--enable-logging). diff --git a/docs/tutorial/dark-mode.md b/docs/tutorial/dark-mode.md index e27d3f2d2688..947675e12e7e 100644 --- a/docs/tutorial/dark-mode.md +++ b/docs/tutorial/dark-mode.md @@ -19,7 +19,7 @@ the system's dark mode setting. You can do this by using the If you want to manually switch between light/dark modes, you can do this by setting the desired mode in the -[themeSource](https://www.electronjs.org/docs/api/native-theme#nativethemethemesource) +[themeSource](../api/native-theme.md#nativethemethemesource) property of the `nativeTheme` module. This property's value will be propagated to your Renderer process. Any CSS rules related to `prefers-color-scheme` will be updated accordingly. diff --git a/docs/tutorial/spellchecker.md b/docs/tutorial/spellchecker.md index cd1f53c9afd0..4854d6515a53 100644 --- a/docs/tutorial/spellchecker.md +++ b/docs/tutorial/spellchecker.md @@ -71,4 +71,4 @@ Although the spellchecker itself does not send any typings, words or user input myWindow.session.setSpellCheckerDictionaryDownloadURL('https://example.com/dictionaries/') ``` -Check out the docs for [`session.setSpellCheckerDictionaryDownloadURL`](https://www.electronjs.org/docs/api/session#sessetspellcheckerdictionarydownloadurlurl) for more information on where to get the dictionary files from and how you need to host them. +Check out the docs for [`session.setSpellCheckerDictionaryDownloadURL`](../api/session.md#sessetspellcheckerdictionarydownloadurlurl) for more information on where to get the dictionary files from and how you need to host them. diff --git a/docs/tutorial/web-embeds.md b/docs/tutorial/web-embeds.md index 110fe713a107..a181ac2fe205 100644 --- a/docs/tutorial/web-embeds.md +++ b/docs/tutorial/web-embeds.md @@ -20,7 +20,7 @@ and only allow the capabilities you want to support. ### WebViews > Important Note: -[we do not recommend you to use use WebViews](https://www.electronjs.org/docs/api/webview-tag#warning), +[we do not recommend you to use use WebViews](../api/webview-tag.md#warning), as this tag undergoes dramatic architectural changes that may affect stability of your application. Consider switching to alternatives, like `iframe` and Electron's `BrowserView`, or an architecture that avoids embedded content