fbda1b4beb
Some checks failed
Deploy to Phoenix / deploy (push) Has been cancelled
- ADD_CHAIN138_TO_LEDGER_LIVE: Ledger form done; public code review repo bis-innovations/LedgerLive; init/push commands - CONTRACT_DEPLOYMENT_RUNBOOK: Chain 138 gas price 1 gwei, 36-addr check, TransactionMirror workaround - CONTRACT_*: AddressMapper, MirrorManager deployed 2026-02-12; 36-address on-chain check - NEXT_STEPS_FOR_YOU: Ledger done; steps completable now (no LAN); run-completable-tasks-from-anywhere - MASTER_INDEX, OPERATOR_OPTIONAL, SMART_CONTRACTS_INVENTORY_SIMPLE: updates - LEDGER_BLOCKCHAIN_INTEGRATION_COMPLETE: bis-innovations/LedgerLive reference Co-authored-by: Cursor <cursoragent@cursor.com>
168 lines
4.2 KiB
Markdown
168 lines
4.2 KiB
Markdown
# Documentation Search Guide
|
||
|
||
**Last Updated:** 2026-02-05
|
||
**Document Version:** 1.1
|
||
**Status:** Active Documentation
|
||
|
||
---
|
||
|
||
## Overview
|
||
|
||
This guide explains how to search and navigate the documentation effectively.
|
||
|
||
---
|
||
|
||
## Search Methods
|
||
|
||
### Method 1: Master Index (Recommended)
|
||
|
||
**File:** [MASTER_INDEX.md](MASTER_INDEX.md)
|
||
|
||
**Usage:**
|
||
1. Open `MASTER_INDEX.md` for the complete documentation index.
|
||
2. Use your editor's search function (Ctrl+F / Cmd+F) to find keywords, topics, or document names.
|
||
3. Follow links to navigate to documents. Documents are organized by category (01–12) with priority ratings.
|
||
|
||
**Alternative:** Use [docs/README.md](README.md) for a shorter overview and category "See" links to each section's README.
|
||
|
||
---
|
||
|
||
### Method 2: Full-Text Search (Command Line)
|
||
|
||
**Using grep:**
|
||
```bash
|
||
# 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):**
|
||
```bash
|
||
# 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 MASTER_INDEX.md** (or search MASTER_INDEX.md for topics):
|
||
- 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/CONFIGURATION_TEMPLATES.md](04-configuration/CONFIGURATION_TEMPLATES.md) - Configuration templates
|
||
- [10-best-practices/CONFIGURATION_DECISION_TREE.md](10-best-practices/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](09-troubleshooting/TROUBLESHOOTING_FAQ.md) - Troubleshooting FAQ
|
||
- [09-troubleshooting/TROUBLESHOOTING_FAQ.md](09-troubleshooting/TROUBLESHOOTING_FAQ.md) - Troubleshooting flow (same as above)
|
||
|
||
---
|
||
|
||
### Finding Architecture Information
|
||
|
||
**Search for:**
|
||
- "architecture" - Architecture documents
|
||
- "network" - Network architecture
|
||
- "vlan" - VLAN configuration
|
||
- "vmid" - VMID allocation
|
||
|
||
**Key Files:**
|
||
- [02-architecture/NETWORK_ARCHITECTURE.md](02-architecture/NETWORK_ARCHITECTURE.md) - Network architecture
|
||
- [02-architecture/VMID_ALLOCATION_FINAL.md](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/QUICK_REFERENCE_CARDS.md](12-quick-reference/QUICK_REFERENCE_CARDS.md) - Network, VMID, 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:**
|
||
```bash
|
||
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
|
||
|
||
- **[MASTER_INDEX.md](MASTER_INDEX.md)** ⭐⭐⭐ - Complete documentation index
|
||
- **[MASTER_INDEX.md](MASTER_INDEX.md)** ⭐⭐⭐ - Master documentation index
|
||
- **[README.md](01-getting-started/README.md)** ⭐⭐ - Documentation overview
|
||
|
||
---
|
||
|
||
**Last Updated:** 2025-01-20
|
||
**Review Cycle:** Quarterly
|