Open-TutorAi/open-tutor-ai-CE

🤖 First Issue: Enhance LLM Response Formatting

Open

#22 opened on Feb 22, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (179 forks)auto 404
good first issue

Repository metrics

Stars
 (84 stars)
PR merge metrics
 (PR metrics pending)

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! 🚀

Contributor guide

Research direction
Identify where LLM responses are displayed, then implement markdown parsing using a library like marked.js. Ensure code blocks and formatting render correctly, and test with examples.
Tech stack
javascript
Domain
frontend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85