doc: update module doc (#31775)
This commit is contained in:
@@ -194,6 +194,17 @@ To add a new translation, head to the [translating doc](docs/translating.md).
|
|||||||
|
|
||||||
For a developer guide, see the [translating dev doc](docs/translating-dev.md).
|
For a developer guide, see the [translating dev doc](docs/translating-dev.md).
|
||||||
|
|
||||||
|
# Extending Element Web with Modules
|
||||||
|
|
||||||
|
Element Web supports a module system that allows you to extend or modify functionality at runtime. Modules are loaded dynamically and provide a safe, predictable API for customization.
|
||||||
|
|
||||||
|
## What are modules?
|
||||||
|
|
||||||
|
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)
|
||||||
|
- Loaded in EW via [config.json](docs/config.md#modules)
|
||||||
|
|
||||||
# Triaging issues
|
# Triaging issues
|
||||||
|
|
||||||
Issues are triaged by community members and the Web App Team, following the [triage process](https://github.com/element-hq/element-meta/wiki/Triage-process).
|
Issues are triaged by community members and the Web App Team, following the [triage process](https://github.com/element-hq/element-meta/wiki/Triage-process).
|
||||||
|
|||||||
+1
-1
@@ -19,7 +19,7 @@
|
|||||||
# Build
|
# Build
|
||||||
|
|
||||||
- [Customisations](customisations.md)
|
- [Customisations](customisations.md)
|
||||||
- [Modules](modules.md)
|
- [Deprecated Modules](deprecated-modules.md)
|
||||||
- [Native Node modules](native-node-modules.md)
|
- [Native Node modules](native-node-modules.md)
|
||||||
|
|
||||||
# Contribution
|
# Contribution
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
# Module system
|
# 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.
|
||||||
|
|
||||||
The module system in Element Web is a way to add or modify functionality of Element Web itself, bundled at compile time
|
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 `yarn build` process but have an effect on user experience
|
for the app. This means that modules are loaded as part of the `yarn build` process but have an effect on user experience
|
||||||
Reference in New Issue
Block a user