Merge pull request #1519 from cachix/do-not-modify-docs

docs: add comment to not modify auto-generated docs

devenv.nix

@@ -110,7 +110,8 @@
       set -e
       output_file=docs/reference/options.md
       options=$(nix build --accept-flake-config --no-pure-eval --extra-experimental-features 'flakes nix-command' --show-trace --print-out-paths --no-link '.#devenv-docs-options')
-      echo "# devenv.nix" > $output_file
+      echo "[comment]: # (DO NOT MODIFY. This file was generated by devenv-generate-doc-options.)" >> $output_file
+      echo "# devenv.nix" >> $output_file
       echo >> $output_file
       cat $options >> $output_file
       # https://github.com/NixOS/nixpkgs/issues/224661
@@ -121,6 +122,8 @@
     description = "Generate an example enabling every supported language.";
     exec = ''
       cat > examples/supported-languages/devenv.nix <<EOF
+      # DO NOT MODIFY.
+      # This file was generated bu devenv-generate-languages-example.
       { pkgs, ... }: {
 
         # Enable all languages tooling!