Open-TutorAi/open-tutor-ai-CE

🤖 First Issue: Enhance LLM Response Formatting

Ouverte

#22 ouverte le 22 févr. 2025

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)JavaScript (179 forks)auto 404
good first issue

Métriques du dépôt

Stars
 (84 étoiles)
MĂ©triques de merge PR
 (Aucune PR mergée en 30 j)

Description

🤖 First Issue: Enhance LLM Response Formatting

Description

The AI tutor's responses need better formatting for readability, especially when explaining concepts, providing examples, or listing steps.

Suggested Improvements

  • đź“Ś Markdown Support: Allow the AI to format responses with bold, italic, bullet points, and code blocks.
  • đź“– Code Highlighting: If the tutor explains coding concepts, ensure proper syntax highlighting.
  • 🎭 Consistent Styling: Improve how different response types (definitions, examples, explanations) are displayed.

Getting Started

  1. Identify where LLM responses are displayed ( API response handler, etc.).
  2. Implement markdown parsing (e.g., using marked.js or another library).
  3. Ensure code blocks and special formatting render correctly.
  4. Test and submit a PR with examples of formatted responses.

Tasks

  • Implement markdown support in AI responses.
  • Improve code syntax highlighting.
  • Test response formatting.
  • Submit a PR.

Priority

🟢 Beginner-Friendly

Additional Notes

This issue is great for frontend or full-stack developers who want to improve LLM usability! 🚀

Guide contributeur

Direction de recherche
Identifiez où les réponses LLM sont affichées, puis implémentez l'analyse Markdown à l'aide d'une bibliothèque comme marked.js. Assurez vous que les blocs de code et le formatage sont correctement rendus et testez avec des exemples.
Stack technique
javascript
Domaine
frontend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
RĂ©cente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JavaScriptMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85