proxmox/docs/SEARCH_GUIDE.md

Documentation Search Guide

Last Updated: 2025-01-20
Document Version: 1.0
Status: Active Documentation

---

Overview

This guide explains how to search and navigate the documentation effectively.

---

Search Methods

Method 1: Search Index

File: SEARCH_INDEX.md

Usage:

1. Open SEARCH_INDEX.md
2. Use your editor's search function (Ctrl+F / Cmd+F)
3. Search for keywords, topics, or file names
4. Click on links to navigate to documents

Generate/Update Index:

cd docs
./scripts/generate_search_index.sh

---

Method 2: Full-Text Search (Command Line)

Using grep:

# Search for keyword in all markdown files
grep -r "keyword" docs/ --include="*.md"

# Case-insensitive search
grep -ri "keyword" docs/ --include="*.md"

# Search with context (3 lines before/after)
grep -ri "keyword" docs/ --include="*.md" -C 3

Using ripgrep (if available):

# Faster search with ripgrep
rg "keyword" docs/

# Search in specific file types
rg "keyword" -t markdown docs/

---

Method 3: IDE/Editor Search

Most IDEs support:

• Global search across all files
• Search in specific directories
• Regex pattern matching
• File name search

Examples:

• VS Code: Ctrl+Shift+F (Cmd+Shift+F on Mac)
• Vim/Neovim: Use :grep or plugins
• Emacs: Use M-x grep or helm-ag

---

Method 4: Tag-Based Search

Use the tag index in SEARCH_INDEX.md:

• Find documents by topic tags
• Tags include: proxmox, besu, cloudflare, vlan, vmid, rpc, ccip, etc.

---

Search Tips

Finding Configuration Information

Search for:

• "configuration" - General configuration guides
• "template" - Configuration templates
• Specific service names (e.g., "besu", "cloudflare", "nginx")

Key Files:

• 04-configuration/templates/ - Configuration templates
• 04-configuration/CONFIGURATION_DECISION_TREE.md - Configuration decision tree

---

Finding Troubleshooting Information

Search for:

• "troubleshooting" - Troubleshooting guides
• "error" - Error messages and solutions
• "issue" - Known issues and fixes
• Specific error messages

Key Files:

• 09-troubleshooting/TROUBLESHOOTING_FAQ.md - Troubleshooting FAQ
• 09-troubleshooting/TROUBLESHOOTING_DECISION_TREE.md - Troubleshooting decision tree

---

Finding Architecture Information

Search for:

• "architecture" - Architecture documents
• "network" - Network architecture
• "vlan" - VLAN configuration
• "vmid" - VMID allocation

Key Files:

• 02-architecture/NETWORK_ARCHITECTURE.md - Network architecture
• 02-architecture/VMID_ALLOCATION_FINAL.md - VMID allocation

---

Finding Quick References

Search for:

• "quick reference" - Quick reference cards
• "commands" - Command references
• "network quick" - Network quick reference

Key Files:

• 12-quick-reference/NETWORK_QUICK_REFERENCE.md - Network quick reference
• 12-quick-reference/COMMANDS_QUICK_REFERENCE.md - Commands quick reference

---

Search Index Structure

The search index is organized by:

1. Category - Documents grouped by category
2. Alphabetical - All documents listed alphabetically
3. Tags - Documents indexed by topic tags

---

Updating the Search Index

Automatic Update:

cd docs
./scripts/generate_search_index.sh

Manual Update:

• Edit SEARCH_INDEX.md directly
• Add new documents to appropriate categories
• Update tags as needed

---

Related Documentation

• SEARCH_INDEX.md ⭐⭐⭐ - Complete searchable index
• MASTER_INDEX.md ⭐⭐⭐ - Master documentation index
• README.md ⭐⭐ - Documentation overview

---

Last Updated: 2025-01-20
Review Cycle: Quarterly