classtranscribe / classtranscribe/FrontEnd

Overhaul of I-Note Generation

Open
#558 0 comments 0 reactions 0 assignees View on GitHub
enhancement inote
Dominant language
JavaScript
Stars
24
Forks
29
PR merge metrics
No merged PRs in 30d

Description

### Problems:

- Process of generating I-Notes uses excessive string searching
- Adding a feature to one file type (epub, pdf, html, latex) means we need to rewrite and change code for all the other file types
- Creating new file output types makes this problem worse

### Possible Solutions
- Use a Sax Parser and Callback functions to automatically generate content (title, text, image, etc...) for each output type without having to make a different file for each type. [example](https://www.baeldung.com/java-sax-parser)

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names no files, tests, or entry points. Start by locating I-Note generation for epub, PDF, HTML, and LaTeX, then compare how each output type searches and assembles strings. Done means the generation approach supports shared content handling and adding output types without rewriting every existing format.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react, redux
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.