docs(core): add note about buildable libs depending on buildable libs (…

…nrwl#8546) Co-authored-by: Isaac Mann <[email protected]>
garydex · Jan 18, 2022 · be8ce09 · be8ce09
1 parent 480cb63
commit be8ce09
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/docs/shared/workspace/buildable-and-publishable-libraries.md b/docs/shared/workspace/buildable-and-publishable-libraries.md
@@ -31,4 +31,6 @@ Buildable libraries are similar to "publishable libraries" described above. Thei
 
 Buildable libraries are mostly used for producing some pre-compiled output that can be directly referenced from an Nx workspace application without the need to again compile it. A typical scenario is to leverage Nx’s [incremental building](/ci/incremental-builds) capabilities.
 
+> Note: In order for a buildable library to be pre-compiled, it can only depend on other buildable libraries. This allows you to take full advantage of incremental builds.
+
 For more details on the mechanics, remember that Nx is an open source project, so you can see the actual impact of the generator by looking at the source code (the best starting point is probably `packages/<framework>/src/generators/library/library.ts`).
diff --git a/...ev/public/documentation/shared/workspace/buildable-and-publishable-libraries.md b/...ev/public/documentation/shared/workspace/buildable-and-publishable-libraries.md
@@ -31,4 +31,6 @@ Buildable libraries are similar to "publishable libraries" described above. Thei
 
 Buildable libraries are mostly used for producing some pre-compiled output that can be directly referenced from an Nx workspace application without the need to again compile it. A typical scenario is to leverage Nx’s [incremental building](/ci/incremental-builds) capabilities.
 
+> Note: In order for a buildable library to be pre-compiled, it can only depend on other buildable libraries. This allows you to take full advantage of incremental builds.
+
 For more details on the mechanics, remember that Nx is an open source project, so you can see the actual impact of the generator by looking at the source code (the best starting point is probably `packages/<framework>/src/generators/library/library.ts`).
Original file line number	Diff line number	Diff line change
Expand Up		@@ -31,4 +31,6 @@ Buildable libraries are similar to "publishable libraries" described above. Thei

		Buildable libraries are mostly used for producing some pre-compiled output that can be directly referenced from an Nx workspace application without the need to again compile it. A typical scenario is to leverage Nx’s [incremental building](/ci/incremental-builds) capabilities.

		> Note: In order for a buildable library to be pre-compiled, it can only depend on other buildable libraries. This allows you to take full advantage of incremental builds.

		For more details on the mechanics, remember that Nx is an open source project, so you can see the actual impact of the generator by looking at the source code (the best starting point is probably `packages/<framework>/src/generators/library/library.ts`).