schnauzer: extend docs on generator frontmatter

bottlerocket-os · Sep 27, 2023 · 865d658 · 865d658
1 parent 0e97ef0
commit 865d658
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/sources/api/schnauzer/README.md b/sources/api/schnauzer/README.md
@@ -36,6 +36,10 @@ std = { version = "v1", helpers = ["base64_decode"] } # or use the object form t
 }
 ```
 
+Templates can also be passed as a string to the schnauzer settings generator binary. In this
+case the frontmatter is omitted, and requirements are passed via the CLI. See the
+[settings generator docs](#the-schnauzer-settings-generator) for more information.
+
 ### The schnauzer Library
 The primary user interface is provided via `schnauzer::render_template` and
 `schnauzer::render_template_file`. These functions require the user to pass the template, as

diff --git a/sources/api/schnauzer/src/lib.rs b/sources/api/schnauzer/src/lib.rs
@@ -32,6 +32,10 @@
 //! }
 //! ```
 //!
+//! Templates can also be passed as a string to the schnauzer settings generator binary. In this
+//! case the frontmatter is omitted, and requirements are passed via the CLI. See the
+//! [settings generator docs](#the-schnauzer-settings-generator) for more information.
+//!
 //! ## The schnauzer Library
 //! The primary user interface is provided via `schnauzer::render_template` and
 //! `schnauzer::render_template_file`. These functions require the user to pass the template, as