From 4c182928e10138812c073b3499c6bd2355780878 Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Tue, 28 Nov 2023 08:45:59 +0000
Subject: [PATCH] Improve Module API docs & example (#26637)

---
 build_config.sample.yaml | 4 ++--
 docs/modules.md          | 2 ++
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/build_config.sample.yaml b/build_config.sample.yaml
index a41e991a59..da3ebb34ad 100644
--- a/build_config.sample.yaml
+++ b/build_config.sample.yaml
@@ -21,5 +21,5 @@ modules:
     # An example of pulling a module from NPM
     - "@vector-im/element-web-ilag-module@^0.0.1"
 
-    # An example of pulling a module from github
-    - "github:vector-im/element-web-ilag-module#main"
+    # An example of pulling a module from local filesystem during development
+    - "file:/home/user/development/element-web-ilag-module"
diff --git a/docs/modules.md b/docs/modules.md
index 86dae10e5a..aeaf04f47c 100644
--- a/docs/modules.md
+++ b/docs/modules.md
@@ -40,6 +40,8 @@ The following requirements are key for any module:
    which takes a single parameter: a `ModuleApi` instance. This instance is passed to `super()`.
 3. The module must be deployed in a way where `yarn add` can access it, as that is how the build system will try to
    install it. Note that while this is often NPM, it can also be a GitHub/GitLab repo or private NPM registry.
+   Be careful when using git dependencies in yarn classic, many lifecycle scripts will not be executed which may mean
+   that your module is not built and thus may fail to be imported.
 
 ... and that's pretty much it. As with any code, please be responsible and call things in line with the documentation.
 Both `RuntimeModule` and `ModuleApi` have extensive documentation to describe what is proper usage and how to set things