An intelligent agent that helps you to onboard to new codebases
Report Bug
·
Request Feature
Table of Contents
askmonk a.k.a "Tuteur de Mistral" is an innovative open-source tool developed to address a common challenge many developers face: the daunting task of navigating and understanding unfamiliar codebases. Created during the Mistral AI Hackathon at Shack 15, organized by Cerebral Valley, this project leverages cutting-edge technologies to provide users with a seamless and educational experience in coding. "Tuteur de Mistral" is more than just a project; it's a step towards making coding more accessible and less intimidating for developers everywhere.
- Demystifying Codebases: Utilizes Mistral Large, MongoDB Vector Store, and Llama-Index to analyze and break down complex codebases into understandable parts, offering step-by-step instructions to users.
- Interactive Tutorial Quiz: Incorporates a quiz feature that tests users on foundational knowledge, facilitating a deeper understanding and retention of the code they are learning.
- Speed and Efficiency: Built with the power of Mistral, our tool demonstrates how complex products can be developed rapidly and efficiently, thanks to the streamlined RAG pipeline using Mistral API and Llama-Index.
- Open-Source Accessibility: As an open-source product, "Tuteur de Mistral" encourages community contributions and collaboration, ensuring continuous improvement and accessibility for all users.
Our vision for "Tuteur de Mistral" is to continuously enhance its capabilities and user experience.
- Integrating knowledge graphs to provide users with a more interconnected and holistic understanding of codebases.
- Developing a visually rich interface to make the learning experience more engaging and intuitive.Expanding the repository coverage to include more languages and frameworks, catering to a wider range of developers.
- Incorporating user feedback mechanisms to continuously improve the tool based on community input and needs.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Dheemanth Manur - [email protected] Harshavardhan K - [email protected]
Project Link: https://github.com/dhmnr/askmonk