search

bitcointranscripts / transcription-review-front-end

https://review.btctranscripts.com
3 stars 7 forks source link

New Editor Interface #297

Closed kouloumos closed 2 months ago

kouloumos commented 3 months ago

Overview

This PR closes #280, it introduces a new Editor interface built using our own modified version of the slate-transcript-editor. Additionally, it includes a significant refactoring of the related code to streamline logic and eliminate redundant code from previous iterations.

I have made an effort to break down the changes into granular commits to facilitate the review process. However, the commit 1d36b53469b2773916392dedf78ac652ee8b2399 could not be further divided. I hope the detailed commits elsewhere will assist reviewers in their evaluation.

Details

The new Editor introduces a new data format (DPE), stored for each transcript in the bitcointranscripts-metadata repository and used as input for the slate-transcript-editor. When a user claims a transcript, we now create two branches: one for DPE and one for markdown. Similarly, when they submit, we open two Pull Requests, one for each repository.

Testing the changes

You can test the changes by pointing your local instance to staging with the following .env variables

NEXT_PUBLIC_APP_TRANSCRIPTION_BASE_URL = "https://brilliant-growth-staging.up.railway.app"
NEXT_PUBLIC_APP_QUEUE_BASE_URL = "https://transcription-review-backend-staging.up.railway.app/api"
NEXT_PUBLIC_VERCEL_ENV = "staging"

Then, claim a transcript and test the new Editor.

Next Steps

Note: the fork of slate-transcript-editor will be moved under the bitcointranscripts org at a later time.

vercel[bot] commented 3 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
transcription-review-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 8, 2024 0:33am
0tuedon commented 2 months ago

So, I did check out the UI work on the Editor, good work but I did encounter some issues

  1. Does the work with the playback feature?? Screenshot 2024-07-12 at 14 04 02

    I encounter a situation where the audio didn't play.

Also took a while to get used to this editor. Also this doesn't support MD?

kouloumos commented 2 months ago

I encounter a situation where the audio didn't play.

Please send a screen recording with the issue.

Also this doesn't support MD?

No. The markdown is generated upon save from the DPE file.

kouloumos commented 2 months ago

Regarding @Emmanuel-Develops comments:

Unable to create new lines: [...] This could be useful for quotes in markdown i.e

As I replied here markdown is not supported. The markdown file is created upon save/submission.

An onboarding flow will be added later to better explain to users what's available and how to use the interface. This includes the way to add new timestamps including everything that is currently available when you hover over the "How Does this work?" text.

submit doesn't save the last changes made to the editor.

This is a known limitation, I will include it in the description. This functionality will be added in subsequent PR.

minor stuck state on exit speaker selection.

This seems to be because of the way the dropdown is implemented. I'll see what I can do to fix it.

kouloumos commented 2 months ago

I updated the PR with all of @Extheoisah suggestions and I also fixed the "minor stuck state on exit speaker selection" issue pointed by @Emmanuel-Develops.