Improve placeholder to explain template strategy

The OUTPUT placeholder now explains why we don't commit generated
content: to keep docs copyable and avoid recursion issues.

Author: basnijholt

docs/contributing.md

@@ -9,7 +9,7 @@ icon: lucide/git-pull-request
 <!-- print(readme_section("contributing")) -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 
 ## Development Setup

docs/docs_gen.py

@@ -27,7 +27,12 @@
 
 # Placeholder comment for OUTPUT sections in docs templates
 # This must be present in committed docs files (not in README.md)
-OUTPUT_PLACEHOLDER = "<!-- ⚠️ This content is auto-generated. Do not edit. -->"
+# Explains our template strategy: output is generated at build time, not committed
+OUTPUT_PLACEHOLDER = (
+    "<!-- ⚠️ This output is generated during CI build. "
+    "We intentionally don't commit generated content to keep docs copyable "
+    "and avoid recursion issues. See docs/docs_gen.py for details. -->"
+)
 
 
 def readme_section(section_name: str, *, strip_heading: bool = True) -> str:

docs/examples.md

@@ -11,7 +11,7 @@ Real-world examples demonstrating the power and flexibility of `markdown-code-ru
 <!-- print(readme_section("examples")) -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 ```
 
@@ -23,7 +23,7 @@ This is an example of a simple code block:
 <!-- print('Hello, world!') -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 ```
 
@@ -38,7 +38,7 @@ First code block:
 <!-- print('Hello, world!') -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 ```
 
@@ -50,7 +50,7 @@ Second code block:
 <!-- print('Hello again!') -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 ```
 
@@ -65,7 +65,7 @@ First code block:
 <!-- print('Hello, world!') -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 
 Second code block:
@@ -74,7 +74,7 @@ Second code block:
 <!-- print('Hello again!') -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 ```
 
@@ -92,7 +92,7 @@ Second code block:
 <!-- print(content) -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 ```
 Which is rendered as:

docs/getting-started.md

@@ -13,7 +13,7 @@ This guide will help you install and start using `markdown-code-runner` in minut
 <!-- print(readme_section("installation")) -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 
 You can also install with `uv`:
@@ -35,7 +35,7 @@ uv tool install markdown-code-runner
 <!-- print(readme_section("quick-start")) -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 
 ## Next Steps

docs/index.md

@@ -15,7 +15,7 @@ icon: lucide/play
 <!-- print(readme_section("intro")) -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 
 <div style="text-align: center; margin: 2rem 0;">
@@ -34,7 +34,7 @@ icon: lucide/play
 <!-- print(readme_section("features")) -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 
 ## Why Use Markdown Code Runner?
@@ -44,7 +44,7 @@ icon: lucide/play
 <!-- print(readme_section("problem-statement")) -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 
 ## Quick Example
@@ -93,5 +93,5 @@ Hello, world!
 <!-- print(readme_section("license")) -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->

docs/usage/cli.md

@@ -24,7 +24,7 @@ This will process the file in-place, executing all code blocks and updating the
 <!-- print("```") -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 
 ## Options

docs/usage/github-actions.md

@@ -13,7 +13,7 @@ Automate your Markdown updates with CI/CD workflows.
 <!-- print(readme_section("github-actions")) -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 
 ## Workflow Breakdown

docs/usage/python-api.md

@@ -9,7 +9,7 @@ icon: lucide/code
 <!-- print(readme_section("python-api")) -->
 <!-- CODE:END -->
 <!-- OUTPUT:START -->
-<!-- ⚠️ This content is auto-generated. Do not edit. -->
+<!-- ⚠️ This output is generated during CI build. We intentionally don't commit generated content to keep docs copyable and avoid recursion issues. See docs/docs_gen.py for details. -->
 <!-- OUTPUT:END -->
 
 ## Function Reference