Skip to content

Add faq (My interval went down (e.g. from 4 to 3 days) after optimizing my FSRS parameters. Why is that?) - #367

Open
GithubAnon0000 wants to merge 4 commits into
ankitects:mainfrom
GithubAnon0000:add-faq
Open

Add faq (My interval went down (e.g. from 4 to 3 days) after optimizing my FSRS parameters. Why is that?)#367
GithubAnon0000 wants to merge 4 commits into
ankitects:mainfrom
GithubAnon0000:add-faq

Conversation

@GithubAnon0000

@GithubAnon0000 GithubAnon0000 commented Apr 10, 2025

Copy link
Copy Markdown
Contributor

Fixes: ankitects/anki#5455
Depends on #403.

Please see #367 (comment) down below for images demonstrating the change.

Old description

Changes

  1. FAQ section has been moved up in the menu, because it didn't allow me to create subsection otherwise.
  2. A subsection (FSRS) has been created for the FAQ.
  3. The FAQ front page description has been updated.
  4. An FAQ (My interval went down (e.g. from 4 to 3 days) after optimizing my FSRS parameters. Why is that?) has been added.

Others

Regarding ankitects/anki#5466: I added it to the manual, but the way it currently is is quite awkward. Ideally, there'd be only one place to look for the FAQs.

I think it's best to move all FAQs from https://faqs.ankiweb.net/ into the FAQ section of the manual, if they haven't been covered already in the main parts of the manual. Afterwards, the link to the faq page should be removed from the faq.md file.

@Expertium

Copy link
Copy Markdown
Contributor

Maybe remove the part about DSR? I think a lot of users won't realize that it means Difficulty, Stability, Reterievability. Or maybe expand it and add this link: https://github.com/open-spaced-repetition/fsrs4anki/wiki/abc-of-fsrs

@GithubAnon0000

Copy link
Copy Markdown
Contributor Author

I opted for expanding it with the link you provided. My reasoning is that it's better to know why optimizing can have this effect, then to just claim that it does.

@Expertium

Copy link
Copy Markdown
Contributor

Oops, typo
Reterievability -> Retrievability

@brishtibheja

Copy link
Copy Markdown
Contributor

I don't like this extra subsection. Is there a issue with having this in the same page? There can be a horizontal line seperating the FAQ you're trying to add and the link to the soon-to-be-legacy FAQ site.

@GithubAnon0000

Copy link
Copy Markdown
Contributor Author

If you look at https://faqs.ankiweb.net/ you can see that the questions are devided into subtopics. Since it's very likely that the FAQ section will expand in the future, I created a subsection (for the subtopics) in advance. That's probably much cleaner than having <hr> everywhere.

@brishtibheja

Copy link
Copy Markdown
Contributor

I have an idea for how a single-page FAQ section would look like and it doesn't have to have a ton of <hr>.

Since it's very likely that the FAQ section will expand in the future

The thing is, if we remove this page later the link would stop working. If, however, we start with the existing page and move towards subsections if/when needed, the current links would still work in the future.

@GithubAnon0000

GithubAnon0000 commented Apr 11, 2025

Copy link
Copy Markdown
Contributor Author

As long as it's clean and obvious, I'm fine with it. Feel free to change the PR (which hopefully is possible for you).

@dae

dae commented Apr 13, 2025

Copy link
Copy Markdown
Member

I'm afraid I'm not fond of this:

  • FAQs are not where the manual should start from
  • I think big FAQ lists are a bit of an anti-pattern. The info is best placed in an appropriate section of the manual, with some topic-specific mini-FAQs being placed on the page if they're really so common that it makes sense to call them out specifically.

@GithubAnon0000

Copy link
Copy Markdown
Contributor Author

FAQs are not where the manual should start from
I'l move it down again (it will break subfolders).

  • The info is best placed in an appropriate section of the manual, with some topic-specific mini-FAQs being placed on the page if they're really so common that it makes sense to call them out specifically.

Does that mean there will be no single FAQ link in the manual? Or should I link the FAQ sections of those topics into the FAQ page?

@dae

dae commented May 19, 2025

Copy link
Copy Markdown
Member

If something makes sense to mention in the relevant section of the manual, I'm suggesting we mention it directly there, not create a separate FAQ page and link to it.

@GithubAnon0000

Copy link
Copy Markdown
Contributor Author

I accidentally purged the previous commits due to a forced reset to head. I hope I included everything.

I now do not touch the faq sections at all and just add admonitions to the fsrs page.

@GithubAnon0000 GithubAnon0000 reopened this Jun 3, 2025
@GithubAnon0000

Copy link
Copy Markdown
Contributor Author

Pictures

When un-collapsed:
anki

When collapsed (default):
anki

@GithubAnon0000
GithubAnon0000 marked this pull request as ready for review June 3, 2025 20:52
@GithubAnon0000

Copy link
Copy Markdown
Contributor Author

[Going through old PRs and closing them. I won't have enough time to update the PRs or develope them further for probably a few months. In case someone wants to continue here, feel free to so.]

@GithubAnon0000

Copy link
Copy Markdown
Contributor Author

I realized I mistakenly closed PRs that should've been kept open. I was in a flow state and just closed stuff without reading...

Sorry about that! Re-opening...

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.

6 participants