From bf9de870d6bfd14b63f9ff143a7697db470fecd6 Mon Sep 17 00:00:00 2001 From: Liam Thompson <32779855+leemthompo@users.noreply.github.com> Date: Wed, 19 Feb 2025 16:00:48 +0100 Subject: [PATCH 1/2] Update file_inclusion.md --- docs/syntax/file_inclusion.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/syntax/file_inclusion.md b/docs/syntax/file_inclusion.md index 9416c531d..6e1600c51 100644 --- a/docs/syntax/file_inclusion.md +++ b/docs/syntax/file_inclusion.md @@ -6,6 +6,10 @@ File inclusion is useful for If there are portions of content that are relevant to multiple pages, you can inject content from another file into any given MD file using the `include` directive. +:::{note} +Files to be included must live in a `_snippets` folder otherwise the docs builder will get mad. This folder can live anywhere. +::: + ### Syntax ```markdown @@ -20,4 +24,4 @@ If there are portions of content that are relevant to multiple pages, you can in ```asciidoc include::shared-monitor-config.asciidoc[] -``` \ No newline at end of file +``` From 18fc90ec609f7ed8a0f663114a9eb0a1123e8e7b Mon Sep 17 00:00:00 2001 From: Liam Thompson <32779855+leemthompo@users.noreply.github.com> Date: Wed, 19 Feb 2025 16:08:29 +0100 Subject: [PATCH 2/2] Docs builder is not a person Co-authored-by: Martijn Laarman --- docs/syntax/file_inclusion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/syntax/file_inclusion.md b/docs/syntax/file_inclusion.md index 6e1600c51..fa472ca06 100644 --- a/docs/syntax/file_inclusion.md +++ b/docs/syntax/file_inclusion.md @@ -7,7 +7,7 @@ File inclusion is useful for If there are portions of content that are relevant to multiple pages, you can inject content from another file into any given MD file using the `include` directive. :::{note} -Files to be included must live in a `_snippets` folder otherwise the docs builder will get mad. This folder can live anywhere. +Files to be included must live in a `_snippets` folder to be considered a snippet file. This folder can live anywhere. ::: ### Syntax