Apply suggestions from code review

Co-authored-by: Copilot <[email protected]>

Author: jstirnaman

.github/workflows/remind-sync-docs.yml

@@ -23,7 +23,9 @@ jobs:
         id: detect-changes
         run: |
           # Get list of changed README files
-          CHANGED_FILES=$(git diff --name-only HEAD~1 HEAD | grep '^influxdata/.*/README\.md$' | head -10)
+          # Limit the number of changed README files to avoid excessive notifications and workflow resource usage
+          CHANGED_FILES_LIMIT=10
+          CHANGED_FILES=$(git diff --name-only HEAD~1 HEAD | grep '^influxdata/.*/README\.md$' | head -$CHANGED_FILES_LIMIT)
           
           if [[ -z "$CHANGED_FILES" ]]; then
             echo "No plugin README files changed"

validate_readme.py

@@ -104,7 +104,8 @@ def validate_examples(content: str) -> List[str]:
     # Check for bash code examples
     bash_examples = re.findall(r'```bash(.*?)```', content, re.DOTALL)
     if len(bash_examples) < 2:
-        errors.append(f"Should have at least 2 bash code examples (found {len(bash_examples)})")
+    if len(bash_examples) < MIN_BASH_EXAMPLES:
+        errors.append(f"Should have at least {MIN_BASH_EXAMPLES} bash code examples (found {len(bash_examples)})")
 
     # Check for influxdb3 commands in examples
     has_create_trigger = any('influxdb3 create trigger' in ex for ex in bash_examples)
@@ -165,7 +166,8 @@ def validate_troubleshooting(content: str) -> List[str]:
         solution_count = section_content.count('**Solution:') + section_content.count('Solution:')
 
         if issue_count < 2:
-            errors.append("Troubleshooting should include at least 2 documented issues")
+        if issue_count < MIN_TROUBLESHOOTING_ISSUES:
+            errors.append(f"Troubleshooting should include at least {MIN_TROUBLESHOOTING_ISSUES} documented issues")
         if issue_count > solution_count:
             errors.append("Each troubleshooting issue should have a corresponding solution")
 
@@ -238,7 +240,7 @@ def validate_readme(readme_path: Path) -> Tuple[List[str], List[str]]:
 
     # Check for optional but recommended sections
     for section in OPTIONAL_SECTIONS:
-        if section not in content and section not in ["### Debugging tips", "### Performance considerations"]:
+        if section not in content and section not in IGNORED_OPTIONAL_SECTIONS:
             warnings.append(f"Consider adding '{section}' section")
 
     # Check for template remnants