Hacker News Reader

Comment by runarberg | Hacker News Reader

I used the same binding for a kanji learning app (https://shodoku.app).

I had some problems with their documentation though. Following their examples was pretty straightforward, but I always had trouble e.g. what is the difference between State.Learning and State.Relearning, or what does fuzzy mean in FSRS parameters, or reps on a Card. You have to either read the algorithm explainer or the Anki source code to understand that.

View on HN

> I had some problems with their documentation though.

I agree that our documentation is pretty bad at the moment haha. But I'm hoping we'll start cleaning things up more this year. I'd also like to potentially move away from using github's wiki system...

On the Anki side: if you document it, I'll answer questions.

hey David :D

Hey stranger :D

Thanks for your work. My issues were exclusively stuff like this page here: https://open-spaced-repetition.github.io/ts-fsrs/interfaces/...

It is great to have the docs well organized like this, what is missing is just a short explanation of what all those mean. The information is available, e.g. in the README or in the source code. So honestly it is just a minor annoyance, rather than a major issue. I was able to use ts-fsrs just fine actually.

It's fine for MIT work.

The Anki database format is still pretty opaque, despite a few efforts over the years, and it would be great to open some of this this up to allow apps to export apkgs

It doesn't help that our wiki is noindexed by GitHub: https://github.com/ankidroid/Anki-Android/wiki/Database-Stru...

Can’t read Anki source unless your work is GPL. Could you share the insights yourself?

My work is MIT, as is ts-fsrs. I said anki source code, but I was being hyperbolic. To understand the different exports of ts-fsrs I had to browse around in different repos at https://github.com/open-spaced-repetition (particularly rs-fsrs; which I think is used in Anki proper) as well as read the algorithm https://github.com/open-spaced-repetition/fsrs4anki/wiki/The... and infer by names being used.

I complain here, but this is open source and if I was slightly more ambitious I would submit PR with the missing docs (or at least an issue).

PS. my work is here https://github.com/runarberg/shodoku in case you are interested, but the source code bears the mark of being a weekend hobby project, so read at own risk ;)

Thanks for sharing details

I'd like to port my own flashcards app, Manabi from SM2 to FSRS so this is helpful

I made this companion reader app as well, btw, for learning Japanese: https://reader.manabi.io

Nice. I jumped straight to FSRS so I can’t compare, but so far I have no regrets. One of my features is I progressively disappear the furigana in the included dictionary and example sentences, as the reading proficiency of the kanji increases (specifically at 99% retrievability) https://github.com/runarberg/shodoku/blob/main/src/helpers/f... This feature was very easy to implement as retrievability is inherent in the algorithm (maybe it is in SM2 as well; I don’t know; but it was trivial in FSRS).

This library also makes it easy to undo a review (one of my missing features) as long as you keep the review records (which this library also makes easy).

Very nice to have these modern setups under freer open source licenses. I have all my data synced to the client to work offline, so it's very nice having FSRS available on iOS & elsewhere (+ ability to run the rust one)

I thought I recognized your username from a political debate here a few months ago. I figured you would enjoy the donations page of my app: https://shodoku.app/about#donations

> If you insist on paying for this app, consider donating to UNWRA instead.

Glad to see solidarity among the Japanese learning community.

Free Palestine!

Not all of Anki's source code is GPL. The FSRS implementation used within Anki is BSD, for example.

I know, my message is about referencing FSRS usage rather than its implementation

Reply on news.ycombinator.com