Skip to content
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

Update Deck Options #250

Merged
merged 54 commits into from
Sep 22, 2024
Merged

Update Deck Options #250

merged 54 commits into from
Sep 22, 2024

Conversation

brishtibheja
Copy link
Contributor

There are links to very old forum posts, mostly outdated, what do we do about them?

@Danika-Dakika
Copy link
Collaborator

Danika-Dakika commented Aug 18, 2024

links to very old forum posts

Which ones specifically?


Also: Is this PR still a work in progress, or are you submitting it for review now?
Are you incorporating new language to fix this as well? Or does it still need to go into the issue tracker?

@brishtibheja
Copy link
Contributor Author

Which ones specifically?

Is this PR still a work in progress, or are you submitting it for review now?

Draft means I'm still working on it. You can still add comments though.

Are you incorporating new language to fix this as well?

I already fixed this. So no need for issue tracker.

@Danika-Dakika
Copy link
Collaborator

Draft means I'm still working on it. You can still add comments though.

That's why I asked -- because that's exactly what I'm trying to avoid. Reviewing incomplete PRs is a waste of time. If there's something significant and specific you need to consult on before your PR is final -- a draft PR might make sense. Is the question you asked about the links the only thing outstanding, and otherwise your work is done?

@brishtibheja
Copy link
Contributor Author

Is the question you asked about the links the only thing outstanding, and otherwise your work is done?

I'm still going through everything. It's not done yet. The draft allows other people to know what I'm doing and optionally comment on it if they want. Expertium will want to see what I do in FSRS section.

the question side should be played when replaying the audio while an answer is
shown. Please note that it does not control what happens when you show the
- **Skip question when replaying answer**: Controls whether audio from
the question side should be played when replaying the audio while on answer side. Please note that it does not control what happens when you show the
answer; for that please see [this section](templates/fields.md#special-fields).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anybody knows what is this cross-referencing? I didn't find anything.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this on point? Replay is controlled with that Deck Options setting -- initial-play is controlled on the template.

FrontSide will not automatically play any audio that was on the front side of the card. If you wish to have the same audio play automatically on both the front and back of the card, you’ll need to manually include the audio fields on the back as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thrown into some unfamiliar section; didn't even noticed that line. I changed this to:

Controls whether audio from the question side is played when you use replay action on the answer side. Note that, Anki does not automatically play audio from the {{FrontSide}} field. This option does not influence the behaviour of automatic play.

@Danika-Dakika
Copy link
Collaborator

Danika-Dakika commented Aug 19, 2024

I'm still going through everything. It's not done yet.

Got it. 👍🏽 I'll wait until you submit it for review.

src/deck-options.md Outdated Show resolved Hide resolved
src/deck-options.md Outdated Show resolved Hide resolved
src/deck-options.md Outdated Show resolved Hide resolved
@brishtibheja brishtibheja requested a review from Expertium August 20, 2024 09:47
src/deck-options.md Outdated Show resolved Hide resolved
src/deck-options.md Outdated Show resolved Hide resolved
src/deck-options.md Outdated Show resolved Hide resolved
@brishtibheja brishtibheja marked this pull request as ready for review August 20, 2024 10:22
@Expertium
Copy link
Contributor

image
@brishtibheja the link to the graph seems to be broken

src/deck-options.md Outdated Show resolved Hide resolved
@bqv
Copy link

bqv commented Sep 10, 2024

My vote is to stick with "scheduler", for what it matters

@Expertium
Copy link
Contributor

You mean "SM-2 scheduler" and "FSRS scheduler"?

@Danika-Dakika
Copy link
Collaborator

Danika: idk, they haven't commented yet

@Expertium I did, I did!
I'm rock solid on drawing the distinction between algorithm and scheduler. FSRS is an algorithm, v3 is a scheduler.

Last month on your Reddit thread:

They are just 2 completely different things. Before FSRS, folks often only spoke in terms of the "scheduler" -- because all versions of the scheduler were using the SM-2 algorithm. But when talking about SM-2, the word "algorithm" has regularly been used, with no confusion.

Now we are just being more transparent about what things are the job of the scheduler and what are the job of the algorithm. I don't think this is actually confusing to people.

@Danika-Dakika
Copy link
Collaborator

Danika-Dakika commented Sep 11, 2024

Can we do further bikeshedding in a different PR?

@brishtibheja It's pretty dismissive to refer to others editing your copy as "bikeshedding" -- or perhaps you and I don't have the same understanding of that term. But, I think that Damien's point is probably a better place to put our focus -- #250 (comment) . This PR is probably just too big.

In the future, even if an entire page needs an update, "do one thing" is still the best guideline to follow.

@brishtibheja
Copy link
Contributor Author

brishtibheja commented Sep 11, 2024

It came up some time ago in discord, but I keep using that word wrong. I agree with you and dae. This was too huge. I think this is in a mergeable form now, so I'll follow up with another PR with formatting changes, etc.

@dae is there anything left to do here? Think it should be good to go now.

@Expertium
Copy link
Contributor

  1. Will the workload-retention graph be updated once the PR is merged?
  2. I recommend waiting for Create frequently-asked-questions-about-fsrs.md faqs#36 to be merged. Then I can add a link to FAQ here. Frankly, I really dislike that the manual and FAQ are two different things, it just cripples discoverability for no reason, since users have to discover the manual and the FAQ separately.
    Anyway, I think linking to FAQ at the end of the FSRS section is reasonable.

@brishtibheja
Copy link
Contributor Author

  1. The graph is already updated. I only needed to delete the previous file and upload the new one with the same name. It's showing the new image in website now.
  2. I'll do a second PR anyway. Also, we link people to the FAQ from the FAQ section of the manual. Yeah, there's a section for that.

@Expertium
Copy link
Contributor

Expertium commented Sep 11, 2024

Also, we link people to the FAQ from the FAQ section of the manual.

Yeah, but unless Dae is fervently against linking to FAQ from Deck Options, I'd like to do so. Same reasoning - improving discoverability, so that users have an easier time finding all the relevant links and info.

@Expertium
Copy link
Contributor

https://faqs.ankiweb.net/frequently-asked-questions-about-fsrs.html

@brishtibheja please add this to deck options. Something like "Several frequently asked questions about FSRS have been answered here"

@dae
Copy link
Member

dae commented Sep 22, 2024

Thanks for all the hard work that went into this.

No objections to linking to the FAQ. Can't remember if I mentioned it elsewhere already, but I actually think we might be better off consolidating all info into the manual in the long run - the separate FAQ page was mainly a convenience for support in the past.

@dae
Copy link
Member

dae commented Sep 22, 2024

(I won't hold up the PR with that change as it's been waiting long enough; follow-up welcome)

@dae dae merged commit 08b6e10 into ankitects:main Sep 22, 2024
@brishtibheja brishtibheja deleted the update-deck-options branch September 22, 2024 06:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants