docs: document the code directory

Incendo · Feb 2, 2024 · 6cf2917 · 6cf2917
1 parent 728811d
commit 6cf2917
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -40,3 +40,9 @@ then you may run prettier using:
 ```shell
 $ npx prettier . --write
 ```
+
+### Snippets
+
+The `code` directory contains a Gradle project with compiled examples.
+Snippets from these docs are used in the examples using the `{{ snippet("File.java") }}` macro.
+The project will be built by the CI pipeline to validate that the snippets compile.