Skip to content

Latest commit

 

History

History
308 lines (256 loc) · 8.38 KB

File metadata and controls

308 lines (256 loc) · 8.38 KB

RMCitecraft Documentation Map

For LLMs: This compact index contains essential docs only. For complete documentation, see docs/FULL_INDEX.md. Last generated: 2026-01-04 13:07:15 UTC

Essential docs: 21 | Total docs: 88 (use Glob/Grep for full search)

Getting Started

Topics: database, census, citation, batch, findagrave

  • Value Proposition
  • Key Features
  • How It Works
  • Use Cases
  • Requirements
  • Technology Stack
  • Installation
  • Quick Start
  • Documentation
  • Caveats and Known Issues

Project Overview

Topics: database, census, citation, batch, findagrave

  • Project Overview
  • Communication Style
  • Do's and Don'ts
  • Setup & Build Steps
  • Test Commands & CI
  • Code Style & Formatting Rules
  • Commit & PR Guidelines
  • Security & Dependency Policies
  • Project-Specific Context
  • Common Tasks

Topics: database, census, citation, batch, findagrave

  • Quick Reference
  • Project Overview
  • Before Modifying Code
  • Project Structure
  • Database Safety (Critical)
  • Citation Formatting
  • Testing
  • Configuration
  • Playwright Browser Automation
  • Key Files

Reference

Topics: database, census, citation, batch, findagrave

  • Overview
  • Database Location
  • Schema Version
  • Tables
  • Extracted Data JSON Formats
  • Indexes
  • Status State Machine
  • Relationship to RootsMagic Database
  • Maintenance
  • Related Documentation

Topics: database, census, citation, batch, testing

  • Overview
  • Database Location
  • Schema Version
  • Architecture
  • Tables
  • Features and Capabilities
  • Sample Queries
  • Cross-Database Queries with RootsMagic
  • Recommended Use Cases
  • Maintenance

Topics: database, census, batch, automation

  • Overview
  • Architecture Diagram
  • Data Models
  • Usage Examples
  • Template Structure
  • Quality Indicators
  • CSS Classes
  • Adding New Census Years
  • File Locations
  • Related Documentation

Topics: citation, evidence-explained, formatting, reference

  • Overview
  • The Three Citation Forms
  • Citation Format by Census Era
  • Special Schedule Types
  • Abbreviations Used
  • Bibliography Format
  • Source Name Format
  • Design Decisions
  • Validation Rules
  • Compatibility Notes

Topics: database, census, citation, batch, testing

  • Database Connection
  • Free-Form Citation Architecture
  • Census Events: Shared Facts
  • Key Database Conventions
  • OwnerType Values
  • MediaType Values

Topics: database, citation, batch, testing, ui

  • Why Comparison-Based Testing is Essential
  • Critical Bugs Caught by Comparison Testing
  • Methodology: Field-by-Field Comparison
  • Required Tests for Each New Record Type
  • Test Organization Pattern
  • When to Run These Tests
  • Reference Implementation
  • Testing Philosophy

Topics: database, census, citation, batch, findagrave

  • Quick Navigation
  • Documentation Purpose
  • Critical Learnings from Database Analysis
  • Testing Philosophy
  • Document Organization
  • How to Use This Documentation
  • Key Reference Patterns
  • Contribution Guidelines
  • Related Documentation

Topics: database, census, citation, ui, automation

  • Overview
  • Database Characteristics
  • Key Concepts
  • Tables by Category
  • Core Entities
  • Events and Facts
  • Sources and Citations
  • Places
  • Multimedia
  • Research Management

Architecture

Topics: database, census, citation, batch, findagrave

  • Overview
  • Architecture Components
  • Batch Processing Workflow
  • Configuration
  • Using Resume Functionality
  • Performance Metrics
  • Error Handling
  • Troubleshooting
  • Architecture Decisions
  • Testing

Topics: database, census, citation, batch, findagrave

  • Overview
  • Key Differences from Find a Grave Processing
  • Architecture Components
  • Batch Processing Workflow
  • Configuration
  • Validation Rules
  • Resume Functionality
  • Export to RootsMagic
  • Error Handling
  • Performance Metrics

Database

Topics: database, census, citation, batch, findagrave

  • 📚 Documentation Categories
  • 🚀 Quick Start Guides
  • 🎯 Key Learnings from Database Analysis
  • 📊 Documentation Map by Feature
  • 🔍 Finding Documentation
  • 📝 Documentation Standards
  • 🔗 Related Documentation
  • 📞 Getting Help

Testing

Topics: census, citation, batch, testing, ui

  • What We Built
  • Quick Start (3 Steps)
  • Test Suites
  • Before First Run
  • What Tests Do
  • Test Output Example
  • Troubleshooting
  • Advanced Usage
  • Files Created
  • Performance

Topics: census, citation, batch, testing, ui

  • Overview
  • Test Coverage
  • Prerequisites
  • Running Tests
  • Test Output
  • Troubleshooting
  • Test Data
  • CI/CD Integration
  • Test Development
  • Performance Benchmarks

Archive

Topics: user-guide, census, batch-processing

  • Overview
  • Before You Begin
  • Step 1: Select Census Year
  • Step 2: Filter Citations
  • Step 3: Start Batch Processing
  • Step 4: Review Each Citation
  • Step 5: Save or Skip
  • Citation Format Output
  • Year-Specific Notes
  • Handling Special Cases

User Guides

Topics: faq, questions, help

  • General Questions
  • Setup Questions
  • Database Questions
  • Citation Questions
  • Processing Questions
  • Image Questions
  • Technical Questions
  • Error Questions
  • Support

Topics: user-guide, installation, setup

  • What is RMCitecraft?
  • Step 1: Install RMCitecraft
  • Step 2: Configure Your Environment
  • Step 3: Set Up Chrome for FamilySearch
  • Step 4: Prepare Your Database
  • Step 5: Start RMCitecraft
  • Step 6: Process Your First Citation
  • Understanding RMCitecraft's Assumptions
  • Next Steps
  • Getting Help

Topics: setup, installation, requirements

  • Overview
  • System Requirements
  • Required Software
  • Required Accounts
  • Optional Components
  • RootsMagic Database Preparation
  • Chrome Configuration for FamilySearch
  • Directory Structure
  • Verification Checklist
  • Common Issues

Topics: troubleshooting, errors, support

  • Quick Diagnostics
  • Installation Issues
  • Database Connection Issues
  • Chrome/FamilySearch Issues
  • Citation Processing Issues
  • Image Issues
  • Performance Issues
  • Recovery
  • Getting More Help
  • Common Error Messages Reference