Skip to content

In-app documentation system (hints.py) - explain what everything does on hover #103

@deucebucket

Description

@deucebucket

Problem

We don't explain things to users. Settings have toggles with no context. Status messages are cryptic. Users don't know:

  • What Skaldleita is or why it exists
  • What each toggle actually does
  • Why certain decisions are made
  • How the verification layers work
  • What "FREE" badge means vs using their API quota

Solution: In-App Wiki / Hints System

Create a hints.py module (or similar) that provides contextual documentation throughout the app:

Features

  1. Hover tooltips - Every toggle, button, and status indicator explains itself on hover
  2. Info icons - Small (i) icons next to complex features that expand to show explanation
  3. Status bar context - "Skaldleita" badge could show "Our free GPU-powered audio identification" on hover
  4. Settings descriptions - Each setting group has a "What is this?" expandable section
  5. First-run guide - New users get a quick tour of key concepts

Implementation

# hints.py
HINTS = {
    "skaldleita": "Our free GPU-powered audio identification service. Transcribes your audiobook intro and matches against 50M+ books. Doesn't use your API quota.",
    "enable_ai_verification": "Use AI (Gemini/OpenRouter/Ollama) to verify book identifications. Can catch errors but may hallucinate on generic titles.",
    "deep_scan_mode": "Re-scan folders even if files haven't changed. Useful after updates or to catch missed books.",
    "trust_the_process": "Auto-apply fixes without confirmation when confidence is high.",
    # ... etc
}

UI Integration

  • Jinja templates pull from hints.py
  • JavaScript shows tooltips on hover
  • Consistent styling across app
  • Easy to update as features change

Priority Hints Needed

  1. What is Skaldleita and why does it exist
  2. What each AI provider does and costs
  3. What verification layers mean
  4. What confidence percentages mean
  5. What "FREE" vs paid API usage means
  6. What each toggle in Settings actually does

Goal

User should never have to ask "what does this do?" - the answer should be one hover away.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P3-mediumBug with workaround, important enhancementfeatureNew capability requested

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions