From 63f474ccbfdd2ae7211c3a6b05d89488a397f61b Mon Sep 17 00:00:00 2001
From: Ivan De Marino <ivan.demarino@hashicorp.com>
Date: Thu, 23 Jun 2022 11:19:27 +0100
Subject: [PATCH] Improved documentation of paths for templates and examples,
 in README

---
 README.md | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 93300f50..8701ef24 100644
--- a/README.md
+++ b/README.md
@@ -44,20 +44,30 @@ Otherwise, the provider developer can set an arbitrary description like this:
 
 ### Conventional Paths
 
-The generation of missing documentation is based on a number of assumptions / conventional paths:
+The generation of missing documentation is based on a number of assumptions / conventional paths.
+
+For templates:
 
 | Path                                                      | Description                            |
 |-----------------------------------------------------------|----------------------------------------|
 | `templates/`                                              | Root of templated docs                 |
 | `templates/index.md[.tmpl]`                               | Docs index page (or template)          |
-| `examples/provider/provider.tf`                           | Provider example config*               |
 | `templates/data-sources.md[.tmpl]`                        | Generic data source page (or template) |
 | `templates/data-sources/<data source name>.md[.tmpl]`     | Data source page (or template)         |
-| `examples/data-sources/<data source name>/data-source.tf` | Data source example config*            |
 | `templates/resources.md[.tmpl]`                           | Generic resource page (or template)    |
 | `templates/resources/<resource name>.md[.tmpl]`           | Resource page (or template)            |
-| `examples/resources/<resource name>/resource.tf`          | Resource example config*               |
-| `examples/resources/<resource name>/import.sh`            | Resource example import command        |
+
+Note: the `.tmpl` extension is necessary, for the file to be correctly handled as a template.
+
+For examples:
+
+| Path                                                      | Description                     |
+|-----------------------------------------------------------|---------------------------------|
+| `examples/`                                               | Root of examples                |
+| `examples/provider/provider.tf`                           | Provider example config         |
+| `examples/data-sources/<data source name>/data-source.tf` | Data source example config      |
+| `examples/resources/<resource name>/resource.tf`          | Resource example config         |
+| `examples/resources/<resource name>/import.sh`            | Resource example import command |
 
 ### Templates