Skip to content

Commit

Permalink
Updating the text
Browse files Browse the repository at this point in the history
  • Loading branch information
profvjreddi committed Nov 18, 2024
1 parent 9646aef commit f444330
Showing 1 changed file with 30 additions and 11 deletions.
41 changes: 30 additions & 11 deletions contents/ai/socratiq.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,16 @@

## Welcome to SocratiQ: Your AI Learning Assistant

We're excited to introduce SocratiQ (pronounced "Socratic"), an innovative AI learning assistant integrated throughout this textbook. SocratiQ helps reinforce your learning through interactive quizzes and personalized assistance. SocratiQ's goal is to adapt to your needs while generating targeted questions and engaging in meaningful dialogue about the material.
Welcome to SocratiQ (pronounced "Socratic"), an innovative AI learning assistant integrated throughout this textbook. Named after the Socratic method of teaching, which emphasizes asking and answering questions to stimulate critical thinking, SocratiQ helps reinforce your learning through interactive quizzes and personalized assistance.

SocratiQ's goal is to adapt to your needs while generating targeted questions and engaging in meaningful dialogue about the material. Unlike traditional textbook study, SocratiQ offers an interactive, personalized learning experience that can help you better understand and retain complex concepts.

## Quick Start Guide

1. Enable SocratiQ using the button below or URL parameters
2. Use keyboard shortcut (`Cmd/Ctrl + K`) to open SocratiQ anytime
3. Set your academic level in Settings
4. Start learning! Look for quiz buttons at the end of sections

Please note that this is an experimental feature. We are experimenting with the idea of creating a dynamic and personalized learning experience by harnessing the power of generative AI. We hope that this approach will transform how you interact with and absorb the complex concepts.

Expand All @@ -28,7 +37,6 @@ You can directly control SocratiQ by adding these parameters to your URL:
This gives you quick access to toggle SocratiQ's functionality directly from your browser's address bar.
:::


Once you've enabled SocratiQ it will always be available when you visit this site.

You can access SocratiQ at any time using a keyboard shortcut shown in @fig-main-shortcut, which brings up the interface shown in @fig-main-interface.
Expand All @@ -37,8 +45,7 @@ You can access SocratiQ at any time using a keyboard shortcut shown in @fig-main

![The main SocratiQ interface, showing the key components of your AI learning assistant.](images/png/interface.png){#fig-main-interface}


## Personalizing Your Learning Experience
## Personalizing Your Learning

Before diving into your studies, take a moment to configure SocratiQ for your academic level. This initial setup ensures that all interactions, from quiz questions to explanations, are tailored to your background knowledge. @fig-settings-panel shows where you can adjust these preferences.

Expand All @@ -48,17 +55,24 @@ You can augment any AI SocratiQ response using the dropdown menu at the top of e

![Redo an AI message by choosing a new experience level..](images/gif/adjust_message_difficulty.gif){#fig-adjust_message_difficulty}


## Learning with SocratiQ

As you progress through each section of the textbook, you'll find automatically generated quizzes designed to reinforce key concepts. These quizzes typically contain 3-5 questions, carefully crafted to check your understanding of the material you've just covered, as shown in @fig-quiz-interface.
As you progress through each section of the textbook, you will find automatically generated quizzes designed to reinforce key concepts. These quizzes typically contain 3-5 questions and take only about 1-2 minutes to complete. These are crafted to check your understanding of the material you've just covered, as shown in @fig-quiz-interface.

![Quizzes are generated at the end of every section.](images/png/quiz_button2.png){#fig-quiz-interface}

After submitting your answers, SocratiQ provides immediate feedback and detailed explanations for each question, as demonstrated in @fig-quiz-feedback.

![Example of AI-generated feedback and explanations for quiz responses.](images/png/quiz_answers.png){#fig-quiz-feedback}

### Example Learning Flow

1. Read a section
2. Select challenging text → Ask SocratiQ for explanation
3. Take the section quiz
4. Review related content suggestions
5. Track progress in dashboard

## Getting Help with Concepts

When you encounter challenging concepts, SocratiQ offers two powerful ways to get help. First, you can select any text from the textbook and ask for a detailed explanation, as demonstrated in @fig-text-selection.
Expand All @@ -76,7 +90,6 @@ You can also click the `+ Context` button right above the input.

![Referencing different sections from the textbook.](images/gif/Reference.gif){#reference-sections}


![An interactive chat session with SocratiQ, demonstrating how to get clarification on concepts.](images/png/chat_explanation.png){#fig-interactive-chat}

To enhance your learning experience, SocratiQ doesn't just answer your questions---it also suggests related content from the textbook that might be helpful for deeper understanding, as shown in @fig-related-content.
Expand All @@ -85,7 +98,7 @@ To enhance your learning experience, SocratiQ doesn't just answer your questions

## Tracking Your Progress

SocratiQ maintains a comprehensive record of your learning journey. The progress dashboard, shown in @fig-progress-dashboard, displays your quiz performance statistics, learning streaks, and achievement badges.
SocratiQ maintains a comprehensive record of your learning journey. The progress dashboard (@fig-progress-dashboard) displays your quiz performance statistics, learning streaks, and achievement badges. This dashboard updates real-time.

![The progress dashboard showing your learning statistics and achievements.](images/png/dashboard.png){#fig-progress-dashboard}

Expand All @@ -107,15 +120,13 @@ The top nav bar provices quick access to 1) New or saved conversations with Socr
## Data Storage

:::{.callout-important}
**Important Note**: All progress data is stored locally in your browser. Clearing your browser history or cache will erase your entire learning history, including quiz scores, streaks, and achievement badges. Please keep this in mind before clearing browser data.
**Important Note**: All progress data is stored locally in your browser. Clearing your browser history or cache will erase your entire learning history, including quiz scores, streaks, and achievement badges.
:::

You can also delete all of your saved conversations by clicking the New Chat button in the nav bar.

![Load or delete previous chats or start a new chat. ](images/png/prev_conversations.png){#fig-previous-conversations}



## Technical Requirements

To use SocratiQ effectively, you'll need:
Expand All @@ -124,6 +135,14 @@ To use SocratiQ effectively, you'll need:
- JavaScript enabled
- Stable internet connection

### Common Issues and Troubleshooting

- If SocratiQ isn't responding: Refresh the page
- If quizzes don't load: Check your internet connection
- If progress isn't saving: Ensure cookies are enabled

For persistent issues, please contact us at vj[@]eecs.harvard.edu.

## Providing Feedback

Your feedback helps us improve SocratiQ. You can report technical issues, suggest improvements to quiz questions, or share thoughts about AI responses using the feedback buttons located throughout the interface.
Expand Down

0 comments on commit f444330

Please sign in to comment.