diff --git a/README.md b/README.md index acadb9c0..2970fa79 100644 --- a/README.md +++ b/README.md @@ -147,6 +147,7 @@ To get started clone and set up this project: ```sh git clone https://github.com/element-hq/element-call.git cd element-call +corepack enable yarn ``` diff --git a/docs/README.md b/docs/README.md index 4866fe4b..d97e8d56 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,9 @@ ## Element Call Docs -This folder contains documentation for Element Call setup and usage. +This folder contains documentation for setup, usage, and development of Element Call. - [Embedded vs standalone mode](./embedded-standalone.md) - [Url format and parameters](./url-params.md) - [Global JS controls](./controls.md) - [Self-Hosting](./self-hosting.md) +- [Developing with linked packages](./linking.md) diff --git a/docs/linking.md b/docs/linking.md new file mode 100644 index 00000000..dd2baa87 --- /dev/null +++ b/docs/linking.md @@ -0,0 +1,12 @@ +# Developing with linked packages + +If you want to make changes to a package that Element Call depends on and see those changes applied in real time, you can create a link to a local copy of the package. Yarn has a command for this (`yarn link`), but it's not recommended to use it as it ends up modifying package.json with details specific to your development environment. + +Instead, you can use our little 'linker' plugin. Create a file named `.links.yaml` in the Element Call project directory, listing the names and paths of any dependencies you want to link. For example: + +```yaml +matrix-js-sdk: ../path/to/matrix-js-sdk +"@vector-im/compound-web": /home/alice/path/to/compound-web +``` + +Then run `yarn install`. diff --git a/docs/self-hosting.md b/docs/self-hosting.md index 26644ed6..8282057d 100644 --- a/docs/self-hosting.md +++ b/docs/self-hosting.md @@ -100,6 +100,7 @@ source. First, clone and install the package: ```sh git clone https://github.com/element-hq/element-call.git cd element-call +corepack enable yarn yarn build ```