INDEX

Complete Index & Sitemap

🗊 Navigation Guide to All Pages

Use this page to find exactly what you're looking for in the Clean BOM Senior documentation.

---

👒 All Pages

Getting Started

• Home — Welcome, overview, and learning paths
• Quick-Start-Guide — Installation, basic usage (5 minutes)

Core Concepts

• Understanding-BOM-and-CRLF — What BOM is, why it matters, technical details
• File-Types-and-Detection — 50+ supported file types, auto-detection
• Architecture-Overview — System architecture, Mermaid flow diagram, internal components
• [Basic-Examples][Basic-Examples] — Practical examples for common tasks

Reference

• Command-Line-Reference — All flags, options, parameters
• CI-CD-Integration — GitHub Actions, GitLab, Jenkins, Docker examples
• Agent-Integration — skills + rules pointer for LLM agents, per-platform entry points, installing the tool

Support

• Troubleshooting-Guide — 12 problems with solutions
• FAQ — 40+ frequently asked questions
• INDEX — This page (complete navigation)

---

📄 Topics by Category

Installation (5 minutes)

1. Quick-Start-Guide - Step-by-step
2. FAQ - Installation & Setup - Common questions

Basic Usage (10 minutes)

1. Quick-Start-Guide - 5 examples
2. Command-Line-Reference - All commands
3. FAQ - Basic Usage - Common patterns

Understanding BOM (20 minutes)

1. Understanding-BOM-and-CRLF - Deep dive
2. FAQ - BOM & Encoding - Technical questions

File Types (15 minutes)

1. File-Types-and-Detection - 50+ types
2. FAQ - File Types - Type-specific questions

Advanced Options (20 minutes)

1. Command-Line-Reference - All flags
2. FAQ - Options & Flags - Common combinations

CI/CD Integration (30 minutes)

1. CI-CD-Integration - 5+ examples
2. Command-Line-Reference - Exit codes
3. FAQ - Advanced - Automation patterns

Troubleshooting (varies)

1. Troubleshooting-Guide - 12 solutions
2. FAQ - Troubleshooting - Common issues

---

🔍 Find by Problem

Problem: Nothing happens

→ Troubleshooting-Guide#problem-1

Problem: Permission denied

→ Troubleshooting-Guide#problem-2

Problem: Script not found

→ Troubleshooting-Guide#problem-3

Problem: BOM still present

→ Troubleshooting-Guide#problem-4

Problem: Git shows all modified

→ Troubleshooting-Guide#problem-5

Problem: Performance issues

→ Troubleshooting-Guide#problem-6

Problem: PHP headers error

→ Troubleshooting-Guide#problem-7

Problem: JSON parse error

→ Troubleshooting-Guide#problem-8

Problem: Script execution fails

→ Troubleshooting-Guide#problem-9

Problem: Backup files not created

→ Troubleshooting-Guide#problem-10

Problem: Dry-run differs from actual

→ Troubleshooting-Guide#problem-11

Problem: Can't modify files

→ Troubleshooting-Guide#problem-12

---

🔌 Find by Option

--dry-run

→ Command-Line-Reference#--dry-run

--backup

→ Command-Line-Reference#--backup

--verbose

→ Command-Line-Reference#--verbose

--file-type

→ Command-Line-Reference#--file-type-type

--exclude

→ Command-Line-Reference#--exclude-dirs

--fix-crlf

→ Command-Line-Reference#--fix-crlf

--force

→ Command-Line-Reference#--force

--fix-gitattributes

→ Command-Line-Reference#--fix-gitattributes

---

👘 Find by File Type

PHP

→ File-Types-and-Detection#php-files

Python

→ File-Types-and-Detection#code-files-24-types

JavaScript

→ File-Types-and-Detection#code-files-24-types

JSON

→ File-Types-and-Detection#json-files

YAML

→ File-Types-and-Detection#markup--data-16-types

Shell Scripts

→ File-Types-and-Detection#shell-scripts

HTML/CSS

→ File-Types-and-Detection#markup--data-16-types

---

📚 Documentation Statistics

• 9 comprehensive pages
• 150+ code examples
• 30+ reference tables
• 40+ FAQ entries
• 12 troubleshooting solutions
• 100+ cross-references
• 5 CI/CD platform examples

---

🚀 Recommended Reading Order

For beginners:

1. Home (2 min) — Overview
2. Quick-Start-Guide (5 min) — Get running
3. FAQ - Basic Usage (5 min) — Common patterns

For intermediate users:

1. Understanding-BOM-and-CRLF (15 min)
2. File-Types-and-Detection (15 min)
3. Command-Line-Reference (20 min)

For advanced users:

1. CI-CD-Integration (25 min)
2. Troubleshooting-Guide (20 min)
3. FAQ - Advanced (10 min)

---

🔒 Search Tips

Use your browser's search (Ctrl+F) to find:

• "Q:" for FAQ questions
• "Problem" for troubleshooting
• "--flag" for command options
• "Example" for code examples
• Specific error message for solutions

---

📎 Quick Links

• GitHub Repository
• Issue Tracker
• Main Wiki
• Author Website

---

This index helps you find exactly what you need in the Clean BOM Senior documentation.