-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
New Editor Interface #297
New Editor Interface #297
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
1474814
to
66ead64
Compare
66ead64
to
6a287f2
Compare
6a287f2
to
0bdcc85
Compare
Please send a screen recording with the issue.
No. The markdown is generated upon save from the DPE file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome features!
Here are some observations I noticed.
In-Editor Observations
- There are situations where I'd like to change the timestamps, for example here's a snippet of a transcript
00:00:20 Aaron van Wirdum Live from Utrecht, this is Bitcoin Explained. Hello Sjors.
00:00:25 Sjors Provoost. What's up? Welcome back. Thank you.
and it should be this
00:00:20 Aaron van Wirdum Live from Utrecht, this is Bitcoin Explained. Hello Sjors.
00:00:25 Sjors Provoost What's up?
00:00:26 Aaron van Wirdum Welcome back.
00:00:27 Sjors Provoost Thank you.
There's no way to edit that on the editor for now. In this case it's a minor issue, but there's no way to resolve it than creating a commit outside the editor.
Apparently, using a shift+enter
creates new timestamps. Attached is a screen recording.
trim.timestamp-1.mov
-
Audio Playback issues.
Sometimes the audio refuses to play, probably the same issue @0tuedon noticed. Although if I leave it for a while it resumes.
Could be bandwidth related (my internet speed is about 20mbps) probably redownloading everytime one skips rather than downloading to memory. -
minor stuck state on exit speaker selection.
If I exit the speaker selection by clicking on itself, the cancel and save buttons don't work.
Screen recording below
click.out.480p.mov
- Unable to create new lines: As mentioned earlier,
shift+enter
creates new timestamps, users are unable to create new lines in the editor. This could be useful for quotes in markdown i.e
quote here
Without new lines, some markdown tags do break.
- submit doesn't save the last changes made to the editor.
Regarding @Emmanuel-Develops comments:
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.
This is a known limitation, I will include it in the description. This functionality will be added in subsequent PR.
This seems to be because of the way the dropdown is implemented. I'll see what I can do to fix it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Quite a long PR.
In general, the pr looks good. I left some comments and nits.
I haven't tested locally though.
necessary additions to support the library
Layout already has a `GlobalContainer`. This is the only page that as an extra one.
0bdcc85
to
ba02b12
Compare
ba02b12
to
404b6c5
Compare
- move the logic for the claim process in a single mutation hook - refactor `/fork` and `/newBranch` endpoints to make them more flexible by moving logic inside the mutation hook for `claimTranscript`
move the modal for restoring the transcript to its original version into its own component
introduce `/github/read` used by the refactored `useReview` hook to read all the required transcript data directly from GitHub
removed previously used implementation of `SelectField` and `SelectBox` components
404b6c5
to
0579970
Compare
0579970
to
8b49537
Compare
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. |
8b49537
to
1f76902
Compare
There are several changes in this commit as I couldn't break them into more granular commits. The changes are: 1. The new editor interface: the data that we started reading directly from GitHub are now utilized in this new interface as part of `SlateTranscriptEditor`. The metadata sidebar have been removed and the required metadata fields are now part of the same page. 2. Refactoring of the save process and new PR process: The`/save` and `/pr` endpoints were ineficiently (and with duplicate code) handling fork and new branch scenarios alongside redundant scenarios from previous queueing logic. Those have been simplified. The logic for saving progress and submitting the review is now part of the `useGitHub` hook. 3. The `SubmitTranscriptAlert` has been moved inside the `SubmitTranscriptModal` alongside a simplified logic for the submit state.
the logic for suggesting a source is now compatible with the refactored github endpoints and part of the `useGithub` hook
1f76902
to
96bf78b
Compare
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 1d36b53 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
variablesThen, 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.