docs: add faq page

2024-05-08 12:23:04 +02:00 · 2024-05-08 12:23:04 +02:00 · 2acd06c9fa
parent 15dd4ea25f
commit 2acd06c9fa
2 changed files with 16 additions and 0 deletions
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@ -82,6 +82,7 @@ nav:
          - reference/clan-core/sops.md
          - reference/clan-core/state.md
  - Contributing: contributing/contributing.md
+  - FAQ: faq/index.md

 docs_dir: site
 site_dir: out
--- a/docs/site/faq/index.md
+++ b/docs/site/faq/index.md
@ -0,0 +1,15 @@
+# FAQ
+
+??? Question "Why is targetHost necessary?"
+
+    When using `clan machines install [machine ][targetHost]`
+
+    Why is targetHost necessary if you already configured target host in the configuration?
+
+??? Question "How to check if the correct installation medium?"
+
+    How to warn and check if it is the only installation medium?
+
+??? Question "How are submodules handled in/with clan?"
+
+    How are submodules handled in/with clan?