Add do not edit comments to all generated docs

bhauman · Oct 12, 2018 · edf2f3a · edf2f3a
1 parent 2f2d487
commit edf2f3a
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/dev/user.clj b/dev/user.clj
@@ -29,7 +29,10 @@
     (string/join "\n" (map sym->markdown-doc syms))))
 
 (defn build-api-docs []
-  (spit "docs/_includes/main-api-docs.md" (api-docs)))
+  (spit "docs/_includes/main-api-docs.md"
+        (str "<!-- DO NOT EDIT: File generated from defn string docs in src/figwheel/main/api.clj -->\n"
+             "<!-- Generation code can be found in user.clj -->\n"
+             (api-docs))))
 
 (defn build-option-docs []
   (doseq [dir ["doc/figwheel-main-options.md" "docs/config-options.md"]]

diff --git a/scripts/kram.rb b/scripts/kram.rb
@@ -6,5 +6,7 @@
                                           hard_wrap: false,
                                           coderay_line_numbers: nil})
   new_name = filename.split("/").last.split(".").first + ".html"
-  File.write('helper-resources/public/com/bhauman/figwheel/helper/content/' + new_name , doc.to_html)
+  content = "<!-- DO NOT EDIT: File generated from Markdown source found in #{filename} -->\n" + doc.to_html 
+
+  File.write('helper-resources/public/com/bhauman/figwheel/helper/content/' + new_name , content)
 end
diff --git a/src/figwheel/main/schema/core.clj b/src/figwheel/main/schema/core.clj
@@ -145,6 +145,9 @@
 layout: config-options
 ---
 
+<!-- DO NOT EDIT: File generated from specs defined in figwheel/main/schema/config.clj -->
+<!-- Generation code can be found in figwheel/main/schema/core.clj -->
+
 # Figwheel Main Configuration Options
 
 This page is a reference for all of the Figwheel configuration options.