Skip to content

User Documentation

Jump to bottom
Ap13Crow edited this page Apr 20, 2025 · 9 revisions

Welcome to the Mia Learning App! This console-based application helps users track courses, manage notes, store vocabulary, and quiz themselves on newly learned words. Below you’ll find everything you need to get started.

Table of Contents

  1. [Getting Started]
  2. [Main Menu Overview]
  3. [Managing Courses]
  4. [Managing Notes]
  5. [Vocabulary Management]
  6. [Progress Summary (Dashboard)]
  7. [Troubleshooting & FAQs]

Getting Started

  1. Download and Install

    • Follow the [Deployment Instructions](#) (link to your “Deployment Instructions” wiki page) to unzip and run the MiaLearningApp.dll (or .exe).

  2. Launch the Application

    • Open a terminal or command prompt, navigate to the extracted folder, and run: 
      dotnet MiaLearningApp.dll
    • On Windows, if you have a self-contained .exe, you can also double-click the .exe in some cases.

  3. Navigate the Console

    • You’ll see a main menu with numbered options. Type the corresponding number and press Enter to select.

Main Menu Overview

When you launch the app, you’ll see something like:

=== Mia Learning App - Main Menu ===
1) View Courses and Progress
2) Add a New Course
3) Update Progress in a Course
4) Manage Notes
5) View Progress Summary (Dashboard)
6) Manage Vocabulary
7) Exit

Each option corresponds to a primary feature in Mia Learning App:

  • 1) View Courses and Progress: Lists all courses and shows % completion.
  • 2) Add a New Course: Create a new course entry with initial progress at 0%.
  • 3) Update Progress in a Course: Set or change the progress % for a specific course.
  • 4) Manage Notes: Add or view notes associated with courses, or search by keyword.
  • 5) View Progress Summary: Shows aggregated stats (e.g., total courses, average progress, total notes, vocabulary count).
  • 6) Manage Vocabulary: Create vocabulary entries in English–Spanish (or your chosen language pair), search them, or quiz yourself.
  • 7) Exit: Close the console application.

Managing Courses

Adding a New Course

  1. From the main menu, select 2) Add a New Course.
  2. Enter the course title (e.g., “Spanish 101”).
  3. The course will be created with 0% progress and saved to the database.

Viewing and Updating Course Progress

  • View Courses: Choose 1) View Courses and Progress from the main menu.
    • You’ll see a list: 
      1) Spanish 101 - 0% complete (Notes: 0)
2) Photography Basics - 30% complete (Notes: 2)
    • Select a course number to see its details (progress, notes).
  • Update Progress: From the main menu, choose 3) Update Progress in a Course.
    • You’ll see a list of courses with their current progress.
    • Select the course number, then enter a new progress value (0–100).

Managing Notes

Adding a Note

  1. Choose 4) Manage Notes from the main menu.
  2. Select 1) Add a New Note.
  3. Pick the course you want the note to attach to.
  4. Enter the note content, such as “Review chapters 2 & 3” or a link to relevant resources.
  5. A confirmation message will appear when the note is saved.

Viewing or Searching Notes

Within Manage Notes, you can:

  • 2) View Notes by Course:
    • Select a course to see all notes attached to it.
  • 3) Search Notes:
    • Type a keyword to find notes that contain it in their content.

Vocabulary Management

Adding Vocabulary Entries

  1. Choose 6) Manage Vocabulary from the main menu.
  2. Select 1) Add a New Word.
  3. Enter:
    • Source Language (defaults to English if blank).
    • Target Language (defaults to Spanish if blank).
    • Source Term (the word/phrase in the source language).
    • Target Term (its translation in the target language).
    • Explanation (optional).
    • Example usage in a sentence (optional).
  4. A success message appears once saved.

Viewing and Searching Vocabulary

  • View All: From Manage Vocabulary, select 2) View All Vocabulary Entries. You’ll see each term, translation, and any explanation/example.
  • Search: Select 3) Search Vocabulary. Enter a keyword, and the app will find any matching source or target terms.

Taking Vocabulary Quizzes

  1. In Manage Vocabulary, choose 4) Take a Quiz.
  2. Enter how many questions you want (e.g., 5).
  3. The app will pick random vocabulary entries and prompt you to type the translation.
  4. After each question, you’ll see if you got it correct and the right answer if not.
  5. At the end, you’ll see your score (e.g., 3/5 correct).

Progress Summary (Dashboard)

Selecting 5) View Progress Summary (Dashboard) from the main menu shows:

  • Total Courses (e.g., 3)
  • Average Course Progress (e.g., 45.0%)
  • Total Notes (across all courses)
  • Total Vocabulary Entries in your database

This quick snapshot helps you track your overall learning progress at a glance.

Troubleshooting & FAQs

  1. App Won’t Launch / CLI Error
    • Make sure .NET 8.0 is installed, or you have the self-contained build. See [Deployment Instructions](#) for details.
  2. SQLite Errors (e.g., “no such table”)
    • Possibly the database is out of sync with the code changes. Re-run migrations or delete the old MiaLearning.db if you can safely lose data.
  3. No Courses Found / No Vocab Found
    • You may be running a fresh database with no data. Simply add a course or vocabulary entries from the menu.
  4. Quiz Doesn’t Have Enough Words
    • If you request more quiz questions than available entries, the app will reduce the quiz length to the number of words you have.

For additional support, file an issue in the [GitHub repository](#) or contact the developer team.

Enjoy using Mia Learning App! If you encounter any problems or would like new features, feel free to open an issue or pull request on the GitHub repository.

Clone this wiki locally