From 9d3164c326efc3270b13cfbea58df2e46c060742 Mon Sep 17 00:00:00 2001
From: Maksym Vlasov <MaxymVlasov@users.noreply.github.com>
Date: Mon, 2 Sep 2024 18:56:06 +0300
Subject: [PATCH] docs(`terraform_docs`): Clarify requrement of
 `--args=--config=` (#711)

---------

Co-authored-by: George L. Yermulnik <yz@yz.kiev.ua>
---
 README.md | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 66d6ea39c..ffce9e648 100644
--- a/README.md
+++ b/README.md
@@ -599,7 +599,7 @@ Unlike most other hooks, this hook triggers once if there are any changed files
         - --hook-config=--use-standard-markers=true     # Boolean. Defaults to true (v1.93+), false (<v1.93). Set to true for compatibility with terraform-docs
     ```
 
-4. You can provide [any configuration available in `terraform-docs`](https://terraform-docs.io/user-guide/configuration/) as an argument to `terraform_doc` hook, for example:
+4. If you want to use a terraform-docs config file, you must supply the path to the file, relative to the git repo root path:
 
     ```yaml
     - id: terraform_docs
@@ -610,7 +610,15 @@ Unlike most other hooks, this hook triggers once if there are any changed files
     > **Warning**  
     > Avoid use `recursive.enabled: true` in config file, that can cause unexpected behavior.
 
-5. If you need some exotic settings, it can be done too. I.e. this one generates HCL files:
+5. You can provide [any configuration available in `terraform-docs`](https://terraform-docs.io/user-guide/configuration/) as an argument to `terraform_docs` hook:
+
+    ```yaml
+    - id: terraform_docs
+      args:
+        - --args=--output-mode=replace
+    ```
+
+6. If you need some exotic settings, it can be done too. I.e. this one generates HCL files:
 
     ```yaml
     - id: terraform_docs