docs: Update script READMEs with consistent formatting

MaterDev · Jan 21, 2025 · c6b3b42 · c6b3b42
1 parent 53c9f68
commit c6b3b42
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/docs/scripts/README.md b/docs/scripts/README.md
@@ -20,20 +20,23 @@ Our documentation system is built on several key principles:
 
 !!! note "Image Management (`image_management/`)"
     Tools for handling images in documentation:
+
     - Metadata scrubbing (especially for Midjourney and DALL-E generated images)
     - Format validation
     - Size optimization
     - Privacy protection for AI service accounts
 
 !!! note "Documentation Validation (`doc_validation/`)"
     Scripts that verify documentation quality:
+
     - Link checking
     - Format validation
     - Structure verification
     - Content integrity checks
 
 !!! note "Log Management (`log_management/`)"
     Tools for maintaining development logs:
+
     - Log file creation and updates
     - Format standardization
     - Content organization

diff --git a/docs/scripts/image_management/README.md b/docs/scripts/image_management/README.md
@@ -1,5 +1,5 @@
 ---
-title: Image Management Scripts
+title: Image Management
 description: Tools for managing and optimizing images in the documentation
 ---
 
@@ -10,12 +10,14 @@ This directory contains scripts for managing and optimizing images used in the d
 ## Purpose
 
 The primary purpose of these tools is to protect privacy and security when using AI-generated images. Many AI image generation services (like Midjourney and DALL-E) embed metadata in images that could potentially:
+
 - Contain account identifiers
 - Include API keys or session data
 - Reveal prompts used for generation
 - Link to personal or organizational accounts
 
 By removing this metadata, we ensure that:
+
 - No sensitive account information is accidentally shared
 - Image generation prompts remain private
 - Account security is maintained
@@ -26,6 +28,7 @@ By removing this metadata, we ensure that:
 ### scrub_metadata.py
 
 Removes metadata (EXIF, XMP, etc.) from images while preserving image quality. This helps:
+
 - Remove AI service identifiers and account data
 - Protect privacy by removing sensitive metadata
 - Reduce file sizes

diff --git a/docs/scripts/log_management/README.md b/docs/scripts/log_management/README.md
@@ -1,4 +1,4 @@
-# Log Management Tools
+# Log Management
 
 This directory contains tools for managing documentation logs within the AI-Pi project. These tools help ensure that logs are properly structured and integrated into the documentation system.