From 5d5c59473bfb42846c06ab7f0b1dfa5832a790ab Mon Sep 17 00:00:00 2001 From: Michael Telatynski <7t3chguy@gmail.com> Date: Mon, 8 Jun 2026 10:32:55 +0100 Subject: [PATCH] Update docs --- apps/web/README.md | 2 +- docs/config.md | 2 +- docs/deprecated-modules.md | 2 +- docs/install.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/apps/web/README.md b/apps/web/README.md index c0683d7017..c4b84a1268 100644 --- a/apps/web/README.md +++ b/apps/web/README.md @@ -126,5 +126,5 @@ Element Web supports a module system that allows you to extend or modify functio Modules are extensions that can add or modify Element Web's functionality. They are: -- Built using the [`@element-hq/element-web-module-api`](https://github.com/element-hq/element-modules/tree/main/packages/element-web-module-api) +- Built using the [`@element-hq/element-web-module-api`](https://github.com/element-hq/element-web/tree/develop/packages/module-api) - Loaded in EW via [config.json](../../docs/config.md#modules) diff --git a/docs/config.md b/docs/config.md index 046a737447..98209c1f8d 100644 --- a/docs/config.md +++ b/docs/config.md @@ -596,7 +596,7 @@ Currently, the following UI feature flags are supported: } ``` -Each module URL is loaded using dynamic import (`import()`). The modules are loaded in order after Element Web initializes but before the application fully starts. Modules must be accessible from the browser and should export a compatible module format that works with the [Module API](https://github.com/element-hq/element-modules/tree/main/packages/element-web-module-api). +Each module URL is loaded using dynamic import (`import()`). The modules are loaded in order after Element Web initializes but before the application fully starts. Modules must be accessible from the browser and should export a compatible module format that works with the [Module API](https://github.com/element-hq/element-web/tree/develop/packages/module-api). ## Undocumented / developer options diff --git a/docs/deprecated-modules.md b/docs/deprecated-modules.md index 1391d8883e..9b95ebd5fd 100644 --- a/docs/deprecated-modules.md +++ b/docs/deprecated-modules.md @@ -1,7 +1,7 @@ # Deprecated Module system > [!CAUTION] -> DEPRECATED. Use [Element web module api](https://github.com/element-hq/element-modules/tree/main/packages/element-web-module-api) instead. +> DEPRECATED. Use [Element web module api](https://github.com/element-hq/element-web/tree/develop/packages/module-api) instead. The module system in Element Web is a way to add or modify functionality of Element Web itself, bundled at compile time for the app. This means that modules are loaded as part of the `pnpm build` process but have an effect on user experience diff --git a/docs/install.md b/docs/install.md index 1829bf0e4a..dcf275f329 100644 --- a/docs/install.md +++ b/docs/install.md @@ -66,7 +66,7 @@ on other runtimes may require root privileges. To resolve this, either run the image as root (`docker run --user 0`) or, better, change the port that nginx listens on via the `ELEMENT_WEB_PORT` environment variable. -[Element Web Modules](https://github.com/element-hq/element-modules/tree/main/packages/element-web-module-api) can be dynamically loaded +[Element Web Modules](https://github.com/element-hq/element-web/tree/develop/packages/module-api) can be dynamically loaded by being made available (e.g. via bind mount) in a directory within `/modules/`. The default entrypoint will be index.js in that directory but can be overridden if a package.json file is found with a `main` directive. These modules will be presented in a `/modules` subdirectory within the webroot, and automatically added to the config.json `modules` field.