Complete documentation index for the Harvous Bible study notes application.
- README.md - Project overview
- GETTING_STARTED.md - Setup, development, and quick start guide
- USER_GUIDE.md - Complete user guide
- FEATURES.md - Feature overview and examples
- ARCHITECTURE.md - Core functionality, data structures, and implementation details
- DATABASE.md - Complete database schema, ERD, and special patterns
- COMPONENTS.md - Component system, hierarchy, and communication patterns
- DATA_FLOW.md - Data flow diagrams and sequence diagrams
- TECH_STACK.md - Technology stack, versions, and dependencies
- PROJECT_STRUCTURE.md - Project organization and directory structure
- API.md - Complete API reference with endpoints and examples
- REACT_ISLANDS_STRATEGY.md - Legacy React Islands notes (historical; production is SPA-only)
- REFACTORING_PLAN.md - Refactoring guidelines and best practices
- SHARED_SPACES_DEV_NOTES.md - Shared spaces: design decisions, visibility rules, permissions (v1 complete)
- LOCKED_NOTES_ENCRYPTION.md - Locked notes: AES-GCM 256-bit, PBKDF2-SHA256 310k iterations (transparency)
- REFERRAL_BONUS_IMPLEMENTATION.md - Referral bonus (100 notes per friend), ReferralPanel, billing limit
- SCRIPTURE_PILL_IMPLEMENTATION.md - Scripture detection and pill system
- SCRIPTURE_FLOW.md - End-to-end scripture flow: create (deferred), verse cache, reprocess on view, update
- NOTE_TYPES_SYSTEM.md - Note types (default, scripture, resource)
- AUTO_TAG_DEBUGGING_GUIDE.md - Auto-tagging system details
- CAPTURE_SYSTEM_DESIGN.md - Capture flow design
- MENU_COMPONENT_DOCUMENTATION.md - Menu system
- THREAD_COMBOBOX_REDESIGN.md - Combobox design
- FONT_AWESOME_REACT_GUIDE.md - FontAwesome integration patterns
- VANILLA_CSS_CLASS_SYSTEM.md - CSS class system and migration guide
- COLOR_SYSTEM_DOCUMENTATION.md - Color system design
- ANIMATION_GUIDELINES.md - Animation patterns and guidelines
- ALPINE_TO_REACT_MIGRATION_PLAN.md - Migration strategy from Alpine.js to React
- ALPINE_JS_LESSONS.md - Alpine.js lessons learned
- NAVIGATION_HISTORY_PERSISTENCE_LESSONS.md - Navigation persistence patterns
- REACT_PORTAL_CLICK_OUTSIDE_LESSONS.md - Portal patterns and lessons
- TYPESCRIPT_INLINE_SCRIPTS.md - TypeScript syntax in inline scripts
- TYPESCRIPT_JSX_CONFIGURATION.md - Legacy: JSX/TypeScript config for Astro + React (Astro removed; kept for reference)
- KEYBOARD_SHORTCUTS.md - Keyboard shortcuts reference
- PWA_INITIAL_LOAD_OPTIMIZATIONS.md - PWA optimization strategies
- User guides and feature documentation
- How-to guides and examples
- Feature overviews
- Architecture and design documentation
- API references
- Component documentation
- Development guides and best practices
- Contributing guidelines
- Development setup
- Code style and patterns
- Migration guides
Want to understand the system? → Start with ARCHITECTURE.md, then explore DATABASE.md and COMPONENTS.md
Want to know what runs in production? → TECH_STACK.md and GETTING_STARTED.md — production is React SPA + Hono API; Astro is used for build tooling and optional dev only, not served in production.
Working on a feature? → Check FEATURES.md and related feature documentation
Building a component? → See COMPONENTS.md and REACT_ISLANDS_STRATEGY.md
Integrating with the API? → Reference API.md for complete endpoint documentation
Setting up development? → See the main README.md for setup instructions
- All documentation uses Markdown format
- Code examples include syntax highlighting
- Diagrams use Mermaid syntax
- Cross-references use relative paths
- Keep documentation up-to-date with code changes
When adding or updating documentation:
-
Place files in appropriate location
- Architecture docs →
docs/ - User guides →
docs/(or root if primary) - Component docs →
docs/
- Architecture docs →
-
Update this index when adding new documentation files
-
Use clear, descriptive titles and organize with headers
-
Include code examples where helpful
-
Cross-reference related docs for easy navigation