update help documentation and re-enable hints in settings
This commit is contained in:
jonasgaudian
@@ -1,53 +1,70 @@
|
||||
# How to Connect to an AI Model
|
||||
## What is an API Key?
|
||||
|
||||
This guide explains how to connect your app to an AI model using an API key.
|
||||
An API key is like a password that lets your app talk to AI services. You need one to use an AI provider like OpenAI (ChatGPT), Anthropic, Mistral, or DeepSeek.
|
||||
|
||||
## Getting Started
|
||||
## Getting an API Key
|
||||
|
||||
To use AI models in your app, you need to provide a valid API key. This key authenticates your requests and tracks your usage.
|
||||
Some providers offer a limited free use of their API, which should be sufficient for most functions of this app; however, it is recommended to use a faster and better-paid service.
|
||||
|
||||
> **Note:** Keep your API key secure and never share it publicly.
|
||||
### For Cloud Providers
|
||||
|
||||
## Key Status Indicators
|
||||
1. Create an account on the provider's website
|
||||
2. Choose a plan or billing option or free tier if available
|
||||
3. Create a new key and copy it
|
||||
4. Paste it into this app
|
||||
|
||||
Your API key can be in one of two states:
|
||||
### For Local AI Servers
|
||||
|
||||
| Status | Icon | Meaning |
|
||||
|--------|------|---------|
|
||||
| Active | ✅ | Key is valid and working |
|
||||
| Missing | ⚠️ | Key is not set or was cleared |
|
||||
Running a local AI server (like Ollama or LM Studio), you don't need an API key. Just add a custom provider:
|
||||
|
||||
### Active Key
|
||||
1. Tap **"Add Custom Provider"**
|
||||
2. Enter your local server IP and endpoint
|
||||
3. Tap **"Check Availability"** to test the connection
|
||||
|
||||
When your API key is active, you can use all available AI models. The system will display a checkmark indicator next to the key status.
|
||||
## Choosing a Model
|
||||
|
||||
### Missing Key
|
||||
### What are Models?
|
||||
|
||||
If the key is missing or cleared, you won't be able to make API requests. You'll see a warning indicator, and any attempt to use AI features will prompt you to add a valid key.
|
||||
A model is a specific AI brain. Different models have different strengths:
|
||||
- **Smaller models**: Faster and cheaper
|
||||
- **Larger models**: Smarter but slower and more expensive
|
||||
|
||||
## Connecting Your AI Model
|
||||
For pre-configured providers, some models are already added by default and proven to work with this app.
|
||||
|
||||
1. **Navigate to Settings** → API Key section
|
||||
2. **Enter your API key** in the provided field
|
||||
3. **Save** the configuration
|
||||
4. **Verify** the connection is successful
|
||||
### Adding Models
|
||||
|
||||
## Troubleshooting
|
||||
1. Open a provider's details
|
||||
2. Tap **Add Model**
|
||||
3. Choose **Scan for Models** to find available ones automatically
|
||||
4. Select the models you want to use
|
||||
|
||||
If you're having issues with your API key:
|
||||
### Assigning Models to Tasks
|
||||
|
||||
1. **Verify the key is correct** - Check for typos or extra spaces
|
||||
2. **Ensure the key has proper permissions** - Some models require additional access
|
||||
3. **Check your quota** - You may have exceeded your usage limits
|
||||
4. **Try regenerating the key** - If all else fails, generate a new key from your provider
|
||||
You can use different models for different features:
|
||||
|
||||
```json
|
||||
// Example API key format
|
||||
{
|
||||
"api_key": "sk-xxxxxxxxxxxxxxxxxxxx"
|
||||
}
|
||||
```
|
||||
1. Go to the **Tasks** tab
|
||||
2. Select which model to use for:
|
||||
- **Translation**: Translates text between languages
|
||||
- **Exercises**: Creates practice exercises
|
||||
- **Vocabulary**: Generates vocabulary and synonyms
|
||||
- **Dictionary**: Looks up definitions
|
||||
|
||||
---
|
||||
## Common Problems
|
||||
|
||||
**Need more help?** Check our documentation or contact support.
|
||||
### "Invalid API Key"
|
||||
- Check for typos or extra spaces
|
||||
- Make sure your key is still active and valid on the provider's website
|
||||
|
||||
|
||||
### "No Models Available"
|
||||
- Make sure your API key is valid first
|
||||
- If on a local network, make sure that your connection and endpoint is configured correctly
|
||||
|
||||
### Slow Responses
|
||||
- Try a faster provider, you might need to choose a paid option
|
||||
- Use a smaller model (look for names with "small" "light" "fast" "nano")
|
||||
|
||||
### Local Server Not Working
|
||||
- Make sure your local server is running
|
||||
- Check that the URL is correct
|
||||
- Your phone and computer might need to be on the same WiFi for local servers.
|
||||
|
||||
@@ -1,30 +1,25 @@
|
||||
# Understanding Categories
|
||||
|
||||
Learn how to use categories to organize and filter your vocabulary effectively.
|
||||
|
||||
## What Are Categories?
|
||||
|
||||
Categories help you organize your vocabulary into meaningful groups. You can use them to track words by topic, difficulty, or any custom system that works for you.
|
||||
Categories help you organize your vocabulary into meaningful groups. You can use them to track words by topic, language, stage, or any custom system that works for you.
|
||||
|
||||
## Two Types of Categories
|
||||
|
||||
### List Categories
|
||||
|
||||
List categories are simple groupings of vocabulary items. Words in a list category stay together regardless of their learning stage.
|
||||
List categories are simple groupings of vocabulary items. You can simply just add words to a list and they stay there forever.
|
||||
|
||||
**Use cases:**
|
||||
- Group words by topic (e.g., "Food", "Travel", "Business")
|
||||
- Create custom decks for specific purposes
|
||||
- Organize words by source (e.g., "Book: Harry Potter")
|
||||
|
||||
### Filter Categories
|
||||
|
||||
Filter categories automatically include all vocabulary items that match certain criteria. Words are dynamically added based on the filter rules.
|
||||
Filter categories automatically include all vocabulary items that match certain criteria. Words are dynamically added or removed based on the filter rules.
|
||||
|
||||
**Use cases:**
|
||||
- Filter by learning stage (e.g., "Words I'm learning")
|
||||
- Filter by mastery level (e.g., "Words I need to review")
|
||||
- Combine multiple criteria for complex filtering
|
||||
- Filter by language
|
||||
- Combine multiple criteria for complex filtering (e.g., "Words in Spanish that I know already")
|
||||
|
||||
## Creating Categories
|
||||
|
||||
@@ -36,14 +31,10 @@ Filter categories automatically include all vocabulary items that match certain
|
||||
|
||||
## Managing Categories
|
||||
|
||||
- **Edit** - Tap a category to modify its settings
|
||||
- **Delete** - Swipe left and tap delete (words are not deleted)
|
||||
- **Reorder** - Drag to change display order
|
||||
- **Edit** - Enter a category to modify its settings
|
||||
|
||||
## Tips
|
||||
|
||||
> **Pro Tip:** Use filter categories for learning stages to automatically track progress across all words at a certain level.
|
||||
|
||||
---
|
||||
|
||||
*Need more help? Check our documentation.*
|
||||
- Use filter categories for learning stages to automatically track progress across all words at a certain level.
|
||||
- The same vocabulary card can appear in several categories
|
||||
- You can also use categories to manage large groups of vocabulary items at once by using the "selct all" feature inside a category
|
||||
@@ -1,4 +1,5 @@
|
||||
# Dictionary Options
|
||||
# Dictionary Options
|
||||
# TODO REWRITE
|
||||
|
||||
Learn how to configure and use the dictionary options for better translations.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
# How to Scan for AI Models
|
||||
# TODO REWRITE
|
||||
|
||||
This guide explains how to use the **Scan** feature to discover and add AI models to your app.
|
||||
|
||||
|
||||
81
app/src/main/assets/hints/exercise_hint.md
Normal file
81
app/src/main/assets/hints/exercise_hint.md
Normal file
@@ -0,0 +1,81 @@
|
||||
## What Are Exercises?
|
||||
|
||||
Exercises help you practice and memorize your vocabulary through interactive activities. You can practice with flashcards, test your spelling, or challenge yourself with word puzzles.
|
||||
|
||||
## Exercise Types
|
||||
|
||||
### Flashcard Mode
|
||||
|
||||
A simple card shows one word, and you guess the translation. Tap to flip and reveal the answer, then mark it as correct or wrong.
|
||||
|
||||
### Spelling Practice
|
||||
|
||||
A word appears and you must type the translation yourself. This is great for memorizing spelling and reinforcing what you've learned.
|
||||
|
||||
### Multiple Choice
|
||||
|
||||
Four answer options are shown and you pick the correct translation. Good for quick recognition practice.
|
||||
|
||||
### Word Jumble
|
||||
|
||||
Letters are scrambled and you must click them in the correct order to spell the word. Excellent for mastering spelling.
|
||||
|
||||
## Starting an Exercise
|
||||
|
||||
1. **From the Dashboard** - Tap the Start Exercise button
|
||||
2. **From a Category** - Open any category and tap Start
|
||||
3. **From the Main Screen** - Tap the floating action button
|
||||
|
||||
## Before You Start
|
||||
|
||||
You can customize your exercise:
|
||||
|
||||
- **How many cards** - Use the slider to pick 1 to 100+ cards
|
||||
- **Quick select** - Tap 10, 25, 50, or 100 for fast selection
|
||||
- **Language direction** - Choose which language to translate from and to
|
||||
- **Exercise types** - Pick one type or mix several together
|
||||
- **Shuffle cards** - Randomize the order
|
||||
- **Shuffle languages** - Randomize which side (word/translation) is shown
|
||||
- **Training mode** - Practice without affecting your progress
|
||||
- **Due today only** - Only practice items scheduled for today
|
||||
|
||||
## Training Mode
|
||||
|
||||
When training mode is ON:
|
||||
- Your answers won't affect your progress stages
|
||||
- No statistics are recorded
|
||||
- Perfect for casual practice or testing yourself
|
||||
|
||||
When training mode is OFF (default):
|
||||
- Correct answers may advance items to higher stages
|
||||
- Progress is saved and tracked
|
||||
- Affects your learning statistics
|
||||
|
||||
## During an Exercise
|
||||
|
||||
The progress bar at the top shows:
|
||||
- **Green** - How many you've gotten right
|
||||
- **Red** - How many you've gotten wrong
|
||||
- **Total** - How many cards in this session
|
||||
|
||||
Tap the close button anytime to exit (you'll be asked to confirm).
|
||||
|
||||
## After Finishing
|
||||
|
||||
Your results screen shows:
|
||||
- Your overall score as a percentage
|
||||
- How many you got right and wrong
|
||||
- Total cards practiced
|
||||
|
||||
You can then:
|
||||
- **Start Over** - Begin a fresh exercise
|
||||
- **Repeat Wrong** - Practice only the cards you missed
|
||||
- **Finish** - Return to the main screen
|
||||
|
||||
## Tips
|
||||
|
||||
- **Mix it up** - Combine different exercise types for variety
|
||||
- **Daily practice** - Use "Due Today Only" for regular reviews
|
||||
- **Focus on mistakes** - Use "Repeat Wrong" to learn from errors
|
||||
- **Start small** - Begin with 10-25 cards and increase over time
|
||||
- **Use training mode** - When you want to practice without pressure
|
||||
@@ -1,4 +1,5 @@
|
||||
# Import Vocabulary with AI
|
||||
# TODO REWRITE
|
||||
|
||||
Generate vocabulary lists automatically using AI assistance.
|
||||
|
||||
|
||||
@@ -1,53 +1,44 @@
|
||||
# Learning Stages
|
||||
|
||||
Understand how vocabulary progresses through different learning stages to optimize your study sessions.
|
||||
|
||||
## The Learning Stages
|
||||
|
||||
Your vocabulary items move through these stages as you learn:
|
||||
Your vocabulary items move through these stages as you learn. In "daily" exercises you get presented with vocabulary items according to their interval.
|
||||
|
||||
| Stage | Name | Interval | Description |
|
||||
|-------|------|----------|-------------|
|
||||
| 🌟 | New | - | Just added vocabulary |
|
||||
| 📅 | Stage 1 | 1 day | Recently learned |
|
||||
| 📅 | Stage 2 | 3 days | Reinforcement |
|
||||
| 📅 | Stage 3 | 1 week | Consolidation |
|
||||
| 📅 | Stage 4 | 2 weeks | Deep learning |
|
||||
| 📅 | Stage 5 | 1 month | Mastery |
|
||||
| ✅ | Learned | ∞ | Fully learned |
|
||||
| Stage | Interval | Description |
|
||||
|------|----------|-------------|
|
||||
| New | 1 day | Just added vocabulary |
|
||||
| Stage 1 | 3 days | Recently learned |
|
||||
| Stage 2 | 1 week | Reinforcement |
|
||||
| Stage 3 | 2 weeks | Consolidation |
|
||||
| Stage 4 | 1 month | Deep learning |
|
||||
| Stage 5 | 2 month | Mastery |
|
||||
| Learned | 3 months | Fully learned |
|
||||
|
||||
## How It Works
|
||||
|
||||
### Answer Correctly ✅
|
||||
### Answer Correctly
|
||||
|
||||
When you correctly identify a word during review:
|
||||
When you correctly identify a word during an exercise:
|
||||
- The word **moves forward** to the next stage
|
||||
- The interval until next review **increases**
|
||||
- This helps you focus on words that need more practice
|
||||
|
||||
### Answer Incorrectly ❌
|
||||
### Answer Incorrectly
|
||||
|
||||
When you make a mistake:
|
||||
- The word **moves back** one or more stages
|
||||
- The word **moves back** one stage
|
||||
- The review interval **decreases**
|
||||
- This ensures you practice challenging words more often
|
||||
|
||||
## Customization
|
||||
|
||||
All intervals and rules can be customized in Settings:
|
||||
All intervals and rules can be customized:
|
||||
|
||||
- **Adjust intervals** for each stage
|
||||
- **Change how many stages** to regress on errors
|
||||
- **Skip stages** for certain word types
|
||||
- **Enable/disable** specific stages
|
||||
- **Change how many attempts** it takes to move up a stage or get demoted
|
||||
- **Skip stages** You can also manually move items to a stage
|
||||
|
||||
## Visual Progress
|
||||
|
||||
The app displays your progress visually:
|
||||
In the dashboard, the app displays your progress visually:
|
||||
- Stage indicators show current status
|
||||
- Progress bars track advancement
|
||||
- Statistics display overall mastery
|
||||
|
||||
---
|
||||
|
||||
*Tip: Consistent daily practice is key to moving words through all stages!*
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
# Review Vocabulary
|
||||
# TODO REWRITE
|
||||
|
||||
Master your vocabulary through systematic review sessions.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
# Sorting Vocabulary
|
||||
# TODO REWRITE
|
||||
|
||||
Learn how to efficiently sort and organize new vocabulary as you add them.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
# Translation Features
|
||||
# TODO REWRITE
|
||||
|
||||
Discover the powerful translation capabilities of this app.
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
# Vocabulary Progress Tracking
|
||||
# TODO REWRITE
|
||||
|
||||
Monitor your vocabulary learning journey with detailed progress statistics.
|
||||
|
||||
|
||||
@@ -47,7 +47,7 @@ fun MainSettingsScreen(
|
||||
Setting(R.string.settings_title_voice, AppIcons.TextToSpeech, SettingsRoutes.TTS_OPTIONS),
|
||||
Setting(R.string.label_logs, AppIcons.Log, SettingsRoutes.LOGS),
|
||||
Setting(R.string.label_languages, AppIcons.Language, SettingsRoutes.LANGUAGE_OPTIONS),
|
||||
//Setting(R.string.hint_settings_title_hints, AppIcons.Info, SettingsRoutes.HINTS_OVERVIEW)
|
||||
Setting(R.string.hint_settings_title_hints, AppIcons.Info, SettingsRoutes.HINTS_OVERVIEW)
|
||||
|
||||
),
|
||||
R.string.settings_header_translator to listOf(
|
||||
|
||||
@@ -225,6 +225,7 @@
|
||||
<string name="label_amount_models">%1$d models</string>
|
||||
<string name="label_analyze_grammar">Analyze Grammar</string>
|
||||
<string name="label_appearance">Appearance</string>
|
||||
<string name="hint_settings_title_hints">Help</string>
|
||||
<string name="label_apply_filters">Apply Filters</string>
|
||||
<string name="label_article">Article</string>
|
||||
<string name="label_backup_and_restore">Backup and Restore</string>
|
||||
|
||||
Reference in New Issue
Block a user