Skip to content

Commit 2b660cd

Browse files
Refactor documentation for consistency and clarity
- Updated performance descriptions across various documents to ensure uniformity. - Enhanced readability by adding new lines in sections of the documentation. - Improved section titles for better understanding of content in scaling strategies and batch scripts. - Adjusted formatting in SQL query patterns for better alignment and readability. - Made minor corrections in related patterns and recommendations in ML and database documentation. - Enhanced PowerShell documentation with structured categories for better navigation. - Improved JavaScript array methods documentation for clarity and usage examples.
1 parent 97c0158 commit 2b660cd

31 files changed

Lines changed: 207 additions & 139 deletions

0

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
1

docs/aspire/orleans-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -517,4 +517,4 @@ app.MapHealthChecks("/health", new HealthCheckOptions
517517

518518
**When to Use**: Building document processing pipelines, coordinating ML workflows, scaling compute-intensive operations
519519

520-
**Performance**: Horizontal scaling with Orleans cluster, automatic load balancing, resource pooling
520+
**Performance**: Horizontal scaling with Orleans cluster, automatic load balancing, resource pooling

docs/aspire/realtime-processing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -538,4 +538,4 @@ await connection.invoke("SubscribeToDocument", documentId);
538538
- **Performance**: Optimized for high-throughput real-time data processing
539539
- **Security**: Implements secure WebSocket connections with authentication
540540
- **Modern C# Features**: Uses primary constructors, records, and async patterns
541-
- **Cloud-Native**: Built for containerized deployment with Aspire orchestration
541+
- **Cloud-Native**: Built for containerized deployment with Aspire orchestration

docs/aspire/scaling-strategies.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
1. [Auto-Scaling Fundamentals](#auto-scaling-fundamentals)
1313
2. [Container Scaling Patterns](#container-scaling-patterns)
1414
3. [Service Load Balancing](#service-load-balancing)
15-
4. [Resource-Based Scaling](#resource-based-scaling)
16-
5. [Orleans Cluster Scaling](#orleans-cluster-scaling)
17-
6. [Database Connection Scaling](#database-connection-scaling)
18-
7. [Monitoring and Metrics](#monitoring-and-metrics)
19-
8. [Configuration Management](#configuration-management)
15+
4. [Resource-Based Scaling Policies](#resource-based-scaling-policies)
16+
5. [Orleans Cluster Scaling Patterns](#orleans-cluster-scaling-patterns)
17+
6. [Monitoring and Alerting Integration](#monitoring-and-alerting-integration)
18+
7. [Implementation Summary](#implementation-summary)
19+
8. [Related Patterns](#related-patterns)
2020

2121
## Auto-Scaling Fundamentals
2222

docs/cmd/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,18 +59,21 @@ exit /b 0
5959
## Key Features
6060

6161
### Production Standards
62+
6263
- **Error Handling**: Comprehensive `%ERRORLEVEL%` checking and meaningful error messages
6364
- **Input Validation**: Parameter validation with usage instructions
6465
- **Logging**: Structured logging with timestamps for audit trails
6566
- **Security**: Input sanitization and safe file operations
6667

6768
### Modern Practices
69+
6870
- **Delayed Expansion**: Proper use of `setlocal enabledelayedexpansion` for variable scope
6971
- **Function Design**: Modular functions with local variable scoping
7072
- **Path Handling**: Robust handling of paths with spaces using quotes
7173
- **Documentation**: Complete header comments with version and purpose
7274

7375
### Enterprise Features
76+
7477
- **Robocopy Integration**: Reliable file operations with progress reporting
7578
- **PowerShell Hybrid**: Integration with PowerShell for advanced operations
7679
- **Service Management**: Windows service control and monitoring
@@ -79,24 +82,28 @@ exit /b 0
7982
## Categories
8083

8184
### File & Directory Operations
85+
8286
- **Advanced Navigation**: `pushd`/`popd`, relative paths with `%~dp0`
8387
- **Robust File Operations**: `robocopy` with retry logic and logging
8488
- **Permission Management**: `icacls` for access control and security
8589
- **Disk Management**: Space monitoring, cleanup automation
8690

8791
### System Administration
92+
8893
- **Service Control**: Start, stop, configure Windows services
8994
- **Process Management**: `tasklist`, `taskkill` with filtering and safety checks
9095
- **Registry Operations**: Safe key manipulation with backup procedures
9196
- **Event Log Management**: Reading and writing Windows Event Log
9297

9398
### Network & Security
99+
94100
- **Connectivity Testing**: Advanced `ping`, `tracert` with logging
95101
- **Network Configuration**: `netsh` commands for interface management
96102
- **Security Scanning**: Port checking, service enumeration
97103
- **Certificate Management**: SSL/TLS certificate operations
98104

99105
### Automation & Integration
106+
100107
- **Scheduled Tasks**: `schtasks` for automated job management
101108
- **WMI Queries**: `wmic` for system information gathering
102109
- **PowerShell Integration**: Hybrid scripts leveraging both engines

docs/cmd/basic-commands.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -614,7 +614,7 @@ exit /b 0
614614
exit /b 0
615615
```
616616

617-
## Directory Management
617+
## Advanced Directory Automation
618618

619619
**Description**: Advanced directory operations with comprehensive safety checks and automation features
620620

docs/cmd/batch-scripts.md

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -207,8 +207,7 @@ REM ============================================================================
207207
208208
call :LogMessage "DEBUG" "File processed successfully: %~nx1"
209209
exit /b 0
210-
```
211-
210+
```cmd
212211
**Usage**:
213212
214213
```cmd
@@ -225,8 +224,7 @@ C:\Scripts>enterprise_template.bat
225224
[Fri 11/01/2025 14:32:15.54] [INFO] Script completed successfully
226225
[Fri 11/01/2025 14:32:15.55] [INFO] Performing cleanup operations
227226
[Fri 11/01/2025 14:32:15.56] [INFO] Script execution finished
228-
```
229-
227+
```cmd
230228
## Automated Backup System
231229
232230
**Description**: Enterprise-grade backup automation with versioning, compression, and retention policies
@@ -454,8 +452,7 @@ exit /b %BACKUP_RESULT%
454452
echo [%TIMESTAMP%] [%LEVEL%] %MESSAGE% >> "%LOG_FILE%"
455453
456454
exit /b 0
457-
```
458-
455+
```cmd
459456
**Usage**:
460457
461458
```cmd
@@ -472,8 +469,7 @@ C:\Scripts>backup_system.bat
472469
[Fri 11/01/2025 14:30:35.69] [INFO] Cleaning up backups older than 30 days
473470
[Fri 11/01/2025 14:30:36.12] [INFO] Cleanup completed - 2 old backups removed
474471
[Fri 11/01/2025 14:30:36.15] [INFO] Backup report generated: D:\Backups\backup_report_20251101.txt
475-
```
476-
472+
```cmd
477473
## System Monitoring & Service Management
478474
479475
**Description**: Comprehensive system monitoring with service health checks, performance monitoring, and automated remediation
@@ -722,8 +718,7 @@ exit /b 0
722718
echo [%TIMESTAMP%] [%LEVEL%] %MESSAGE% >> "%LOG_FILE%"
723719
724720
exit /b 0
725-
```
726-
721+
```cmd
727722
**Usage**:
728723
729724
```cmd
@@ -747,7 +742,7 @@ C:\Scripts>system_monitor.bat
747742
[Fri 11/01/2025 15:00:19.12] [INFO] Generating comprehensive system report
748743
[Fri 11/01/2025 15:00:20.45] [INFO] System report saved: C:\Scripts\system_status_20251101.html
749744
[Fri 11/01/2025 15:00:20.47] [INFO] System monitoring session completed
750-
```
745+
```cmd
751746
echo ========================================== > "%REPORT_FILE%"
752747
echo SYSTEM INFORMATION REPORT >> "%REPORT_FILE%"
753748
echo Generated on: %date% at %time% >> "%REPORT_FILE%"
@@ -780,17 +775,15 @@ ipconfig /all >> "%REPORT_FILE%"
780775
echo Report generated: %REPORT_FILE%
781776
echo Opening report in notepad...
782777
notepad "%REPORT_FILE%"
783-
```
784-
778+
```cmd
785779
**Usage**:
786780
787781
```cmd
788782
C:\Scripts>system_info.bat
789783
Generating system information report...
790784
Report generated: system_report_20251101.txt
791785
Opening report in notepad...
792-
```
793-
786+
```cmd
794787
## Menu-Driven Script
795788
796789
**Code**:
@@ -877,8 +870,7 @@ goto MENU
877870
echo Goodbye!
878871
pause
879872
exit /b 0
880-
```
881-
873+
```cmd
882874
**Usage**:
883875
884876
```cmd
@@ -901,8 +893,7 @@ OS Name: Microsoft Windows 11 Pro
901893
Total Physical Memory: 16,384 MB
902894
System Type: x64-based PC
903895
Press any key to continue . . .
904-
```
905-
896+
```cmd
906897
## Error Handling and Logging
907898
908899
**Code**:
@@ -959,8 +950,7 @@ if %ERROR_COUNT% gtr 0 (
959950
echo Check %LOG_FILE% for details.
960951
type "%LOG_FILE%"
961952
)
962-
```
963-
953+
```cmd
964954
**Usage**:
965955
966956
```cmd
@@ -975,8 +965,7 @@ Fri 11/01/2025 14:45:12.36: ERROR: Copying files failed
975965
Fri 11/01/2025 14:45:12.37: WARNING: Deleting temporary files - no files found or access denied
976966
Fri 11/01/2025 14:45:12.38: Operation completed with 1 errors
977967
=== Operation Finished ===
978-
```
979-
968+
```cmd
980969
**Notes**:
981970
982971
**Enterprise Batch Scripting Best Practices**:

docs/database/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1304,4 +1304,4 @@ public class QdrantConfig
13041304

13051305
**When to Use**: Large-scale document processing systems, ML-intensive applications, multi-modal data storage, real-time analytics requirements
13061306

1307-
**Performance**: Optimized indexing, connection pooling, batch operations, horizontal scaling capabilities
1307+
**Performance**: Optimized indexing, connection pooling, batch operations, horizontal scaling capabilities

docs/database/ml-databases.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -680,4 +680,4 @@ services:
680680
681681
---
682682
683-
**Recommendation**: Use PostgreSQL with pgvector as your primary database, add Chroma for vector operations, and ClickHouse for analytics. This gives you the best balance of features, performance, and developer experience for ML development.
683+
**Recommendation**: Use PostgreSQL with pgvector as your primary database, add Chroma for vector operations, and ClickHouse for analytics. This gives you the best balance of features, performance, and developer experience for ML development.

docs/design-patterns/factory.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,7 @@ compositeLogger.Log("This will be logged to all registered loggers");
144144
```
145145

146146
**Notes**:
147+
147148
- **Simple Factory**: Encapsulates object creation logic in a single method
148149
- **Flexibility**: Easy to add new logger types without changing client code
149150
- **Configuration**: Supports parameterized creation for different configurations
@@ -154,6 +155,7 @@ compositeLogger.Log("This will be logged to all registered loggers");
154155
- **Testability**: Easy to mock and unit test individual logger implementations
155156

156157
**Related Patterns**:
158+
157159
- Strategy Pattern: For interchangeable logging strategies
158160
- Abstract Factory: For creating families of related logging components
159-
- Builder Pattern: For complex logger configuration
161+
- Builder Pattern: For complex logger configuration

0 commit comments

Comments
 (0)