Home

Welcome

Welcome to the technical documentation of the BurkimBbA project. This open-source project is not only about translation but also about building and contributing to the development of local AI for everyone. We aim to collect, process, and translate texts, audio, and videos in the Mooré language to create efficient and accessible AI-driven solutions.

Documentation Structure

Our documentation follows the golden tech structure proposed by Divio, which organizes content into four main categories:

1. Tutorials: Step-by-step guides to help you get started with the project.
2. How-to guides: Practical instructions to complete specific tasks.
3. Explanations: Insights into key concepts and technical decisions.
4. References: Detailed documentation of APIs, file formats, and configurations.

📖 Learn More

• Divio Documentation - Explanations

• Divio Documentation - How-to Guides

• Divio Documentation - Tutorials

How to Contribute

1. Read this page and learn how to classify your documentation properly.
2. Create a branch and submit a Pull Request.
3. At least two reviewers' approvals are required before merging.
4. What to change:
5. Create a file in the appropriate category (e.g., docs/explanations/my_article.md).
6. Update the SUMMARY.md file to include your new file path.

We hope this documentation helps you understand, use, and contribute to the project effectively. Together, we are building AI solutions that empower local communities. Happy exploring! 🚀