Open-TutorAi/open-tutor-ai-CE

馃 First Issue: Enhance LLM Response Formatting

Open

#22 opened on Feb 22, 2025

聽(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