Update several links and pages

extension-js · Nov 4, 2024 · af4105f · af4105f
1 parent 6ef4e25
commit af4105f
Show file tree

Hide file tree

Showing 19 changed files with 196 additions and 183 deletions.
diff --git a/docs/en/docs/browsers/_meta.json b/docs/en/docs/browsers/_meta.json
@@ -1,22 +1,22 @@
 [
   {
-    "name": "available",
+    "name": "browsers-available",
     "label": "Browsers Available"
   },
   {
-    "name": "preferences",
+    "name": "browser-preferences",
     "label": "Browser Preferences"
   },
   {
-    "name": "flags",
+    "name": "browser-flags",
     "label": "Browser Flags"
   },
   {
-    "name": "profile",
+    "name": "browser-profile",
     "label": "Browser Profile"
   },
   {
-    "name": "unsupported",
-    "label": "Running Browsers From Binary"
+    "name": "running-other-browsers",
+    "label": "Running Other Browsers"
   }
 ]
diff --git a/docs/en/docs/browsers/flags.mdx → docs/en/docs/browsers/browser-flags.mdx b/docs/en/docs/browsers/flags.mdx → docs/en/docs/browsers/browser-flags.mdx
@@ -60,5 +60,5 @@ If your target browser is not listed here, it may not have publicly disclosed it
 
 ## Next Steps
 
-- Learn more about [Browser Preferences](./preferences.mdx).
+- Learn more about [Browser Preferences](./browser-preferences.mdx).
 - Explore [Browser-Specific Environment Files](../features/environment-variables.mdx).
diff --git a/docs/en/docs/browsers/preferences.mdx → .../en/docs/browsers/browser-preferences.mdx b/docs/en/docs/browsers/preferences.mdx → .../en/docs/browsers/browser-preferences.mdx
@@ -87,4 +87,4 @@ For a comprehensive list of available Firefox preferences, you can explore the [
 ## Next Steps
 
 - Learn more about [browser-specific environment files](../features/environment-variables.mdx).
-- Explore how to [configure other browser preferences](./available.mdx).
+- Explore how to [configure other browser preferences](./browsers-available.mdx).
diff --git a/docs/en/docs/browsers/profile.mdx → docs/en/docs/browsers/browser-profile.mdx b/docs/en/docs/browsers/profile.mdx → docs/en/docs/browsers/browser-profile.mdx
diff --git a/docs/en/docs/browsers/available.mdx → docs/en/docs/browsers/browsers-available.mdx b/docs/en/docs/browsers/available.mdx → docs/en/docs/browsers/browsers-available.mdx
@@ -34,5 +34,5 @@ Any browser based on the Chromium engine (e.g., Brave or Opera) is supported wit
 
 ## Next Steps
 
-- [Customize your browser configuration](./flags.mdx) using the `--browser-args` flag.
-- [Learn more about unsupported browsers](./unsupported.mdx) and how to run your extension on them.
+- [Customize your browser configuration](./browser-flags.mdx) using the `--browser-args` flag.
+- [Learn more about unsupported browsers](./running-other-browsers.mdx) and how to run your extension on them.
diff --git a/docs/en/docs/browsers/unsupported.mdx → .../docs/browsers/running-other-browsers.mdx b/docs/en/docs/browsers/unsupported.mdx → .../docs/browsers/running-other-browsers.mdx
@@ -2,15 +2,15 @@ import { AvatarBrowsers } from "../../../../theme/components/avatar-group/browse
 
 <AvatarBrowsers browsers={["waterfox", "opera", "brave"]} />
 
-# Running Browsers From Binary
+# Running Other Browsers From Binary Path
 
 > **Warning**: This feature is a work in progress and may be incomplete or subject to change. If you see an error or something that could be improved, please make a pull request. The link that documents this feature can be found at the bottom of the page.
 
-While Extension.js natively supports browsers like Chrome, Edge, and Firefox, you can also run unsupported browsers by specifying the path to the browser binary using the `--chromiumBinary` or `--geckoBinary` flags. Additionally, you can add custom binary paths via the `extension.config.js` file for persistent configuration across runs.
+While Extension.js natively supports browsers like Chrome, Edge, and Firefox, you can also run unsupported browsers by specifying the path to the browser binary using the `--chromium-binary` or `--gecko-binary` flags. Additionally, you can add custom binary paths via the `extension.config.js` file for persistent configuration across runs.
 
 ## How Does It Work?
 
-If you need to run a browser that is not fully supported by Extension.js, you can specify the path to a custom browser binary using the `--chromiumBinary` or `--geckoBinary` flags. Extension.js will launch the specified browser binary with your extension loaded, allowing you to test your extension in a custom browser environment.
+If you need to run a browser that is not fully supported by Extension.js, you can specify the path to a custom browser binary using the `--chromium-binary` or `--gecko-binary` flags. Extension.js will launch the specified browser binary with your extension loaded, allowing you to test your extension in a custom browser environment.
 
 **Example Using CLI Flags:**
 
@@ -45,20 +45,20 @@ In these scenarios, the browser specified in the `--chromiumBinary` or `--geckoB
 
 Here is a short list of browsers you can run using these binary flags, along with their official websites for reference:
 
-| **Browser Name**              | **Type**               | **CLI Flag**       | **Official Website**                                      |
-| ----------------------------- | ---------------------- | ------------------ | --------------------------------------------------------- |
-| **Brave**                     | Chromium-Based Browser | `--chromiumBinary` | [brave.com](https://brave.com)                            |
-| **Opera**                     | Chromium-Based Browser | `--chromiumBinary` | [opera.com](https://www.opera.com)                        |
-| **Vivaldi**                   | Chromium-Based Browser | `--chromiumBinary` | [vivaldi.com](https://vivaldi.com)                        |
-| **Waterfox**                  | Gecko-Based Browser    | `--geckoBinary`    | [waterfox.net](https://www.waterfox.net)                  |
-| **Firefox Developer Edition** | Gecko-Based Browser    | `--geckoBinary`    | [firefox.com](https://www.mozilla.org/firefox/developer/) |
+| **Browser Name**              | **Type**               | **CLI Flag**        | **Official Website**                                      |
+| ----------------------------- | ---------------------- | ------------------- | --------------------------------------------------------- |
+| **Brave**                     | Chromium-Based Browser | `--chromium-binary` | [brave.com](https://brave.com)                            |
+| **Opera**                     | Chromium-Based Browser | `--chromium-binary` | [opera.com](https://www.opera.com)                        |
+| **Vivaldi**                   | Chromium-Based Browser | `--chromium-binary` | [vivaldi.com](https://vivaldi.com)                        |
+| **Waterfox**                  | Gecko-Based Browser    | `--gecko-binary`    | [waterfox.net](https://www.waterfox.net)                  |
+| **Firefox Developer Edition** | Gecko-Based Browser    | `--gecko-binary`    | [firefox.com](https://www.mozilla.org/firefox/developer/) |
 
 ## Example Configuration
 
-Below is an example configuration using the `--geckoBinary` flag to run a custom Firefox instance with specific preferences and flags:
+Below is an example configuration using the `--gecko-binary` flag to run a custom Firefox instance with specific preferences and flags:
 
 ```bash
-extension dev --geckoBinary=/path/to/custom-firefox --profile=/path/to/firefox/profile
+extension dev --gecko-binary=/path/to/custom-firefox --profile=/path/to/firefox/profile
 ```
 
 Or via `extension.config.js`:
@@ -87,4 +87,4 @@ module.exports = {
 
 ## Next Steps
 
-- Check out the [browser preferences](./preferences.mdx) to further configure your environment.
+- Check out the [browser preferences](./browser-preferences.mdx) to further configure your environment.
diff --git a/docs/en/docs/commands/build.mdx b/docs/en/docs/commands/build.mdx
@@ -117,4 +117,4 @@ In this example, the build targets all supported browsers and includes polyfills
 ## Next Steps
 
 - Use the `extension.config.js` file to [configure your extension](https://github.com/extension-js/extension.js/tree/main/examples).
-- Learn more about the [browsers available](../browsers/available.mdx).
+- Learn more about the [browsers available](../browsers/browsers-available.mdx).
diff --git a/docs/en/docs/commands/create.mdx b/docs/en/docs/commands/create.mdx
@@ -99,4 +99,4 @@ This command creates a new extension named my-new-extension using the React temp
 ## Next Steps
 
 - Learn how to [develop](/docs/commands/dev) your extension.
-- Use the `extension.config.js` file to [configure your extension](../features/config.mdx).
+- Use the `extension.config.js` file to [configure your extension](../features/extension-configuration.mdx).
diff --git a/docs/en/docs/commands/dev.mdx b/docs/en/docs/commands/dev.mdx
@@ -52,8 +52,8 @@ Below is a breakdown of the available flags for the `dev` command:
 | `--polyfill`        | Boolean                      | Enables compatibility for the `browser.*` API in Chromium-based browsers                                                                                | `false`           |
 | `--profile`         | Profile path                 | Specifies a path to a browser profile for testing                                                                                                       | `default`         |
 | `-b, --browser`     | Browser to run the extension | Specifies the browser to run (`chrome`, `edge`, `firefox`, `all`)                                                                                       | `"chrome"`        |
-| `--chromium-binary` | Path to the Chromium binary  | Provides the path to a custom Chromium-based browser binary [Read more](../browsers/unsupported.mdx)                                                    | `undefined`       |
-| `--gecko-binary`    | Path to the Gecko binary     | Provides the path to a custom Gecko-based browser binary [Read more](../browsers/unsupported.mdx)                                                       | `undefined`       |
+| `--chromium-binary` | Path to the Chromium binary  | Provides the path to a custom Chromium-based browser binary [Read more](../browsers/running-other-browsers.mdx)                                                    | `undefined`       |
+| `--gecko-binary`    | Path to the Gecko binary     | Provides the path to a custom Gecko-based browser binary [Read more](../browsers/running-other-browsers.mdx)                                                       | `undefined`       |
 | `--starting-url`    | URL                          | Starting URL for testing with the extension                                                                                                             | `chrome://newtab` |
 | `--open`            | Boolean                      | Whether or not to automatically open the browser upon starting dev                                                                                      | `true`            |
 
@@ -127,5 +127,5 @@ Below is a breakdown of the available flags for the `dev` command:
 ## Next Steps
 
 - Once development is complete, it's time to [build your extension](/docs/commands/build).
-- Learn how to create features specific to a browser with the [browser-specific manifest fields](/docs/features/browser-fields).
-- Use the `extension.config.js` file to [configure your extension](/docs/features/config).
+- Learn how to create features specific to a browser with the [browser-specific manifest fields](/docs/features/browser-specific-fields).
+- Use the `extension.config.js` file to [configure your extension](/docs/features/extension-configuration).
diff --git a/docs/en/docs/commands/preview.mdx b/docs/en/docs/commands/preview.mdx
@@ -45,8 +45,8 @@ In this example, the extension is created in the `path/to/my-extension` director
 | [path or url]       | The extension path or the remote extension URL | If a path is defined, previews the local extension. If a URL is provided, pulls the extension from remote source and previews it as a local extension | `process.cwd()`   |
 | `--profile`         | Profile path                                   | Specifies a path to a browser profile for testing                                                                                                     | `default`         |
 | `-b, --browser`     | Browser to run the extension                   | Specifies the browser to run (`chrome`, `edge`, `firefox`, `all`)                                                                                     | `"chrome"`        |
-| `--chromium-binary` | Path to the Chromium binary                    | Provides the path to a custom Chromium-based browser binary [Read more](../browsers/unsupported.mdx)                                                  | `undefined`       |
-| `--gecko-binary`    | Path to the Gecko binary                       | Provides the path to a custom Gecko-based browser binary [Read more](../browsers/unsupported.mdx)                                                     | `undefined`       |
+| `--chromium-binary` | Path to the Chromium binary                    | Provides the path to a custom Chromium-based browser binary [Read more](../browsers/running-other-browsers.mdx)                                                  | `undefined`       |
+| `--gecko-binary`    | Path to the Gecko binary                       | Provides the path to a custom Gecko-based browser binary [Read more](../browsers/running-other-browsers.mdx)                                                     | `undefined`       |
 | `--starting-url`    | URL                                            | Starting URL for testing with the extension                                                                                                           | `chrome://newtab` |
 
 ## Examples
@@ -95,4 +95,4 @@ In this example, the extension is created in the `path/to/my-extension` director
 ## Next Steps
 
 - Learn how to [build](/docs/commands/build) your extension.
-- Use the `extension.config.js` file to [configure your extension](/docs/features/config).
+- Use the `extension.config.js` file to [configure your extension](/docs/features/extension-configuration).
diff --git a/docs/en/docs/development/manifest-json.mdx b/docs/en/docs/development/manifest-json.mdx
@@ -55,5 +55,5 @@ When developing cross-browser extensions, it's important to account for minor di
 
 ## Next Steps
 
-- Learn how Extension.js handles [Manifest Compatibility](../features/browser-fields.mdx) to avoid browser-specific issues.
+- Learn how Extension.js handles [Manifest Compatibility](../features/browser-specific-fields.mdx) to avoid browser-specific issues.
 - Explore how Extension.js works with [Special Folders](../features/special-folders.mdx) to handle additional HTML, scripts, and assets in your project.