docs: fix docs

Excoriate · Mar 30, 2024 · cffb75e · cffb75e
1 parent 7637f1a
commit cffb75e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/.markdownlintignore b/.markdownlintignore
@@ -1,9 +1,10 @@
 .github/PULL_REQUEST_TEMPLATE.md
 docs/contribution_guidelines.md
-docs/contribution_guidelines.md
-docs/contribution_guidelines.md
 .github/ISSUE_TEMPLATE/**.md
 CONTRIBUTING.md
 modules/**/README.md
 examples/**/**/README.md
 CHANGELOG.md
+# Add these lines to ignore specific README.md files for MD025
+infra/terraform/live/_modules/README.md
+infra/terraform/live/_providers/README.md
diff --git a/README.md b/README.md
@@ -97,6 +97,9 @@ For more details on how to use Terragrunt and Terraform effectively within this
 - [Terragrunt Documentation](https://terragrunt.gruntwork.io/docs/)
 - [Terraform Documentation](https://www.terraform.io/docs/)
 
+
+>**NOTE**: Each layer of this architecture has its own README file with detailed explanations and examples.
+
 ## Contributing 🤝
 
 Contributions are welcome! If you have improvements or fixes, please open a pull request. For major changes or new features, please open an issue first to discuss what you would like to change.