Home

AI-Hints Documentation

Welcome to the complete documentation for the AI-Hints Anki add-on.

AI-Hints uses Artificial Intelligence to generate helpful hints and multiple-choice options for your flashcards during review, simulating real exam conditions by including the correct answer alongside plausible distractors.

Quick Start

1. Installation & API Keys — install the add-on and get your API keys.
2. Features — an overview of everything AI-Hints can do.
3. Configuration — a complete reference to every setting, tab by tab.
4. Configuration Reference (all keys) — every raw config key, default, and purpose.
5. Batch Generation — bulk-generate hints for entire decks.
6. Mobile Support — run AI-Hints on AnkiDroid, AnkiMobile, and AnkiWeb.
7. Troubleshooting — solve common problems.
8. Data & Storage Format — what's stored in your notes and how it's used.
9. Storage, Files & State — all data files, JSON stores, and runtime variables.
10. Frontend (JavaScript) Reference — the unified JS renderer, runtime globals, data contract, and pycmd protocol.
11. Architecture & Code — high-level architecture and per-module description, plus the build / test / release workflow for contributors.

Links

• Install from AnkiWeb: https://ankiweb.net/shared/info/2119980872
• GitHub: https://github.com/athulkrishna2015/AI-Hints
• Report an Issue: https://github.com/athulkrishna2015/AI-Hints/issues
• Releases: https://github.com/athulkrishna2015/AI-Hints/releases
• Changelog: https://github.com/athulkrishna2015/AI-Hints/blob/master/changelog.md
• Configuration Reference: https://github.com/athulkrishna2015/AI-Hints/blob/master/docs/config-reference.md
• Data & Storage Format: https://github.com/athulkrishna2015/AI-Hints/blob/master/docs/data-format.md
• Storage, Files & State: https://github.com/athulkrishna2015/AI-Hints/blob/master/docs/storage.md
• Frontend (JavaScript) Reference: https://github.com/athulkrishna2015/AI-Hints/blob/master/docs/frontend.md
• Architecture & Code: https://github.com/athulkrishna2015/AI-Hints/blob/master/docs/architecture.md