Note about EditKit

ChimeHQ · May 15, 2024 · ce2f6a8 · ce2f6a8
1 parent 8eabfa0
commit ce2f6a8
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/Edit/Chime.docc/Structure.md b/Edit/Chime.docc/Structure.md
@@ -15,3 +15,7 @@ Build settings should be set within xcconfig files, and all targets should have
 The application's code is organized into pretty fine-grained modules via static libraries. These should all use the `Module` xcconfig.
 
 However, due to an Xcode bug, static libraries that depend on SPM modules with non-Swift code will fail to build. To workaround this, those modules need to use the `WorkaroundModule` config file. This bug is transitive, so if module A depends on B, and B uses one of these problematic packages, **both** A and B need to use `WorkaroundModule`. I realize this is annoying and I would very much like to find a more reasonable solution.
+
+### EditKit
+
+Most internal modules are linked into a dynamic framework container called `EditKit`. This is used by the main Edit executable, along with the Quick Look preview and AppIntent extension.