feat: enhance documentation with additional examples and improve spelling consistency

Author: dataGriff

.vscode/settings.json

@@ -14,6 +14,8 @@
     "gofmt",
     "GOPATH",
     "Lipgloss",
+    "pycache",
+    "pyproject",
     "Taskfile"
   ]
 }

docs/agents.md

@@ -24,20 +24,23 @@ Each agent gives you actionable feedback, not just complaints!
 This agent ensures your project has the fundamental files that make it professional and approachable:
 
 **🎯 README File** - Your project's front door
+
 - Looks for `README.md`, `README.rst`, or similar
 - This is the first thing people see!
 
 **🤝 Contributing Guidelines** - How others can help
+
 - Searches for `CONTRIBUTING.md`
 - Shows people how to get involved
 
 **📚 Documentation Directory** - The knowledge base
+
 - Validates that you have a `docs/` folder
 - Checks that it actually contains useful content
 
 ### How It Scores
 
-```
+```txt
 Your Score = (Files Found) ÷ (Files Required)
 ```
 
@@ -134,7 +137,7 @@ validation:
 
 #### Minimal Project Structure
 
-```
+```txt
 project/
 ├── README.md
 ├── CONTRIBUTING.md
@@ -146,7 +149,7 @@ project/
 
 #### Incomplete Project Structure
 
-```
+```txt
 project/
 └── README.md
 ```
@@ -168,7 +171,7 @@ The Git Configuration Agent checks for:
 
 ### Scoring Algorithm
 
-```
+```txt
 Score = (Present Files + Weighted Optional Files) / (Total Required Files + Weighted Optional Files)
 ```
 
@@ -253,7 +256,7 @@ func detectProjectType(targetPath string) []string {
 
 #### Well-Configured Git Setup
 
-```
+```txt
 project/
 ├── .gitignore        # Language-appropriate ignore rules
 ├── .editorconfig     # Consistent code formatting
@@ -264,7 +267,7 @@ project/
 
 #### Minimal Git Setup
 
-```
+```txt
 project/
 ├── .gitignore        # Basic ignore rules
 └── .editorconfig     # Basic formatting rules
@@ -287,7 +290,7 @@ The Development Standards Agent performs these checks:
 
 ### Scoring Algorithm
 
-```
+```txt
 Score = (Valid Commits / Total Commits Checked) * 0.7 + (Branch Naming Valid ? 0.3 : 0)
 ```
 

docs/configuration.md

@@ -54,6 +54,7 @@ cbi schema --output schema.json
 ```
 
 **Schema validation catches:**
+
 - ✅ **Type errors** - Wrong data types (string vs boolean)
 - ✅ **Invalid values** - Out of range numbers, unknown enum options
 - ✅ **Typos** - Misspelled property names
@@ -110,6 +111,7 @@ validation:
 *The foundation checker - makes sure your project has the basics covered.*
 
 **Core Settings:**
+
 ```yaml
 essential-files:
   enabled: true
@@ -281,7 +283,7 @@ validation:
     format: "table"
     verbose: true
     styling:
-      colors: true           # Enable colored output
+      colors: true           # Enable coloured output
       unicode_symbols: true  # Use Unicode symbols (✓, ✗, ⚠)
       show_score: true      # Show numerical scores
       show_summary: true    # Show overall summary
@@ -506,7 +508,7 @@ Invalid configuration will result in an error with specific details about the is
 When updating configuration:
 
 1. Test changes locally first
-2. Update documentation if validation behavior changes
+2. Update documentation if validation behaviour changes
 3. Communicate changes to team members
 4. Consider backward compatibility
 
@@ -540,7 +542,6 @@ Error: commit_history_depth must be a positive integer, got: -5
 
 ## Further Reading
 
-- [Agent Documentation](agents.md) - Detailed agent behavior and customization
+- [Agent Documentation](agents.md) - Detailed agent behaviour and customization
 - [Usage Guide](usage.md) - CLI usage instructions
 - [Examples](examples/) - Real-world configuration examples
-