docs

Pale Fire Documentation

Complete documentation for the Pale Fire knowledge graph search system.

📚 Table of Contents

Getting Started

• DOCKER.md - Docker deployment guide (recommended)
• PALEFIRE_SETUP.md - Manual installation and setup guide
• QUICK_REFERENCE.md - Quick command reference
• CONFIGURATION.md - Configuration options and environment variables

User Guides

• CLI_GUIDE.md - Command-line interface documentation
• API_GUIDE.md - REST API documentation and examples

Features & Concepts

• RANKING_SYSTEM.md - 5-factor intelligent ranking system
• NER_ENRICHMENT.md - Named Entity Recognition enrichment
• QUESTION_TYPE_DETECTION.md - Question type detection (WHO/WHERE/WHEN)
• QUERY_MATCH_SCORING.md - Query term matching algorithm
• VOICES.md - Parallel multi-model LLM requests and session logging

Advanced Topics

• ARCHITECTURE.md - System architecture and design
• REFACTORING_UTILS.md - Code organization and utils refactoring
• TESTING.md - Testing guide and best practices
• TEST_SUITE_SUMMARY.md - Test suite overview and statistics
• DATABASE_CLEANUP.md - Database cleanup and maintenance
• EXPORT_FEATURE.md - JSON export functionality
• ENTITY_TYPES_UPDATE.md - Entity types in connections

Research & Theory

• PROS-CONS.md - Pale Fire framework for dataset representation
• EVALUATION.md - Evaluation framework for interpretive AI systems

Changelog & Migration

• CHANGELOG_CONFIG.md - Configuration system migration
• MIGRATION_SUMMARY.md - Project migration summary
• EXPORT_CHANGES.md - Export format changes

Meta

• DOCUMENTATION_STRUCTURE.md - Documentation organization

🚀 Quick Links

For New Users

1. Start with DOCKER.md for easy deployment
2. Or follow PALEFIRE_SETUP.md for manual setup
3. Check QUICK_REFERENCE.md
4. Try the CLI_GUIDE.md

For Developers

1. Read ARCHITECTURE.md
2. Explore API_GUIDE.md
3. Review CONFIGURATION.md
4. Run tests with TESTING.md

For Advanced Users

1. Understand RANKING_SYSTEM.md
2. Learn about NER_ENRICHMENT.md
3. Master QUESTION_TYPE_DETECTION.md

For Researchers

1. Explore PROS-CONS.md - Theoretical framework
2. Review EVALUATION.md - Evaluation methodology
3. Study ARCHITECTURE.md - System design

📖 Documentation Organization

docs/
├── README.md                      # This file
│
├── Getting Started/
│   ├── DOCKER.md                 # Docker deployment
│   ├── PALEFIRE_SETUP.md         # Manual setup guide
│   ├── QUICK_REFERENCE.md        # Quick reference
│   └── CONFIGURATION.md          # Configuration
│
├── User Guides/
│   ├── CLI_GUIDE.md              # CLI documentation
│   └── API_GUIDE.md              # API documentation
│
├── Features/
│   ├── RANKING_SYSTEM.md         # Ranking system
│   ├── NER_ENRICHMENT.md         # NER enrichment
│   ├── QUESTION_TYPE_DETECTION.md # Question detection
│   └── QUERY_MATCH_SCORING.md    # Query matching
│   └── VOICES.md                 # Voices for parallel LLMs
│
├── Advanced/
│   ├── ARCHITECTURE.md           # Architecture
│   ├── TESTING.md                # Testing guide
│   ├── TEST_SUITE_SUMMARY.md     # Test suite summary
│   ├── DATABASE_CLEANUP.md       # Database cleanup
│   ├── EXPORT_FEATURE.md         # Export feature
│   └── ENTITY_TYPES_UPDATE.md    # Entity types
│
├── Research & Theory/
│   ├── PROS-CONS.md              # Pale Fire framework
│   └── EVALUATION.md             # Evaluation methodology
│
└── Changelog/
    ├── CHANGELOG_CONFIG.md       # Config migration
    ├── MIGRATION_SUMMARY.md      # Migration summary
    └── EXPORT_CHANGES.md         # Export changes

🔍 Search Documentation

Use your browser's search (Ctrl+F / Cmd+F) or grep:

# Search all documentation
grep -r "search term" docs/

# Search specific files
grep "search term" docs/*.md

📝 Contributing to Documentation

When adding new documentation:

1. Place .md files in the docs/ folder
2. Update this README with a link
3. Use relative links between docs
4. Follow the existing format and style

🆘 Getting Help

If you can't find what you're looking for:

1. Check the QUICK_REFERENCE.md
2. Search the documentation
3. Review the CLI_GUIDE.md or API_GUIDE.md
4. Check the main README

---

Pale Fire Documentation - Everything you need to know! 📚