refactor: #57 init mkdocs documentation (#58)

- use a tool to create the docs

- removes the previous wiki docs

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "docs"]
- path = docs
- url = [email protected]:miguelcsx/aura.wiki.git

README.md

@@ -1,104 +1,24 @@
 # AURA - Adaptative Utility and Routine Assistant
 
-AURA is a chatbot and virtual study assistant designed to facilitate and enhance the learning process at an educational level. The primary goal of AURA is to leverage the principles of the memory curve and spaced repetition to help students retain information more effectively.
+AURA is an innovative API designed to revolutionize the way students learn. It provides a comprehensive platform where students can access a wide range of educational resources, receive personalized recommendations, and track their progress. AURA is built to enhance the learning experience by offering targeted support, adaptive learning routines, and intelligent assistance.
 
 ![Image](resources/images/logo.png)
 
 ## Key Features
 
-1. **Customized Topics** 
+1. **Unified Learning Hub**: Unified Learning Hub: Access all possible educational resources from a single platform, eliminating the need to juggle multiple tabs or applications. AURA integrates various content types like videos, flashcards, and quizzes to provide a well-rounded learning experience.
 
-* AURA allows users to select specific areas of study they want to focus on. 
+2. **Personalized Learning Assistance**: AURA supports students during their learning journey by presenting tailored content, reinforcing knowledge through interactive elements such as videos, flashcards, and questions.
 
- This provides a highly personalized learning experience, tailored to the individual interests and needs of each user.
+3. **Performance Tracking**: Continuously measures student performance to provide actionable insights and improve recommendations, ensuring an effective learning path.
 
-* Users can choose from a wide range of academic subjects and areas of interest.
+4. **Question Handling and Support**: When a student has a question, AURA offers a list of related questions to provide immediate assistance. If further help is needed, AURA utilizes a tiered support system:
 
- This includes subjects such as mathematics, sciences, languages, history, among others.
+ - **LLM Support**: If related questions don’t resolve the query, AURA employs a Language Learning Model (LLM) to answer.
+ - **Advisor Connection**: If the LLM's response is insufficient, AURA connects the student with an advisor.
+ - **Expert Teacher Assistance**: As a last resort, AURA connects the student with a subject matter expert to ensure the question is thoroughly resolved.
 
-2. **Topic Review System** 
-
-* Through its conversational interface, AURA presents users with questions, exercises, or materials related to the selected topics.
-
- This can take the form of quizzes, flashcards, practical exercises, among others.
-
-* Users can interact with AURA by answering questions and receiving immediate feedback.
-
- This feedback helps reinforce understanding and identify areas for improvement.
-
-3. **Spaced Repetition** 
-
-* AURA employs a spaced repetition system to schedule review sessions optimally.
-
- Questions or exercises are presented at specific time intervals, based on the forgetting curve and user performance.
-
-* This technique is designed to maximize long-term retention and strengthen long-term memory.
-
- Users actively review topics at critical times to enhance their ability to recall information in the future.
-
-4. **Grading and Feedback** 
-
-* After each study session or quiz, AURA provides a performance evaluation to the user.
-
- This may include scores, performance statistics, and identified strengths and weaknesses.
-
-* Additionally, AURA offers detailed feedback on user responses.
-
- This feedback helps users better understand concepts and correct errors.
-
-5. **Data Management** 
-
-* AURA allows users to organize and manage their study materials efficiently.
-
- Users can create and store their own study cards, notes, vocabulary lists, among others.
-
-* The application also offers tools to import and export data from and to other sources, such as note-taking apps or online learning platforms.
-
- This facilitates the integration of external resources into the study process.
-
-6. **Multi-Language Support** 
-
-* Although initially available in English and Spanish, AURA has the ability to support multiple languages.
-
- This expands its accessibility to a global audience of students, regardless of their native language or language preference for study.
-
-* The application offers content and support in various languages, including the translation of questions and study materials.
-
-7. **Cross-Platform Compatibility** 
-
-* AURA is designed to be compatible with a variety of devices and operating systems.
-
- This includes desktop computers, laptops, tablets, and mobile devices.
-
-* Users can access AURA through a web application or a dedicated mobile app, allowing them to study anytime and anywhere.
-
-8. **Graphical User Interface (GUI)** 
-* AURA's user interface is intuitive and easy to navigate.
-
- Users can interact with the application naturally, using text commands.
-
-* The AURA GUI is integrated with Discord, to make it much easier to interact with the user
-
-9. **External API Integration** 
-* AURA integrates with various external APIs to enhance the study experience.
-
- This includes integrations with calendars, reminders, messaging services, and task management systems.
-
-* Users can sync their study calendar with other applications and receive notifications about upcoming study sessions, exam dates, and learning-related events.
-
-10. **Statistical Reports and Insights** 
-* AURA collects performance data and study habits from users to generate detailed reports.
-
- These reports provide information on user progress, study time, toughest topics, and areas for improvement.
-
-* Additionally, AURA provides personalized recommendations to optimize the study strategy.
-
- These recommendations are based on statistical analysis and machine learning algorithms that identify study patterns and individualized improvement suggestions.
-
-11. **Login for users**
-* Users will have the option to log in to AURA using their Discord accounts.
-
- This provides a convenient and familiar login method for users who are already active on Discord.
+5. **Adaptive Learning Pathways**: Monitors student performance across various subjects, offering diverse learning strategies and continuously adapting to improve the student's learning process.
 
 ## Usage
 
@@ -124,17 +44,17 @@ To use AURA, follow these steps:
 3. Run the application:
 
  ```bash
- python -m app.main
+ python main.py
  ```
 
-## License
-
-This project is licensed under the [MIT License](LICENSE).
-
 ## Acknowledgements
 - This project was inspired by the desire to improve educational outcomes through technology.
 
 - Special thanks to the contributors and supporters of this project.
 
 ## Support
 For questions, issues, or suggestions, please [open an issue](https://github.com/miguelcsx/aura/issues).
+
+
+## License
+This project is licensed under the [MIT License](LICENSE).

docs/docs/index.md

@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+ mkdocs.yml # The configuration file.
+ docs/
+  index.md # The documentation homepage.
+  ... # Other markdown pages, images and other files.

docs/mkdocs.yml

@@ -0,0 +1 @@
+site_name: My Docs