Stvad
Better documentation for CrowdAnki
I've recently started to use CrowdAnki and I've noticed that its pretty hard to find out what a particular field means in the .json file. I have had to try to figure out what the names mean and what the content is by trial and error or comparing two different files, but that is very inconvenient. For beginners, it would be very helpful if there was some documentation on what each term means. I understand that this is a big ask and will probably take a while, but it definitely will be helpful to understand how CrowdAnki works. If possible, I'd also like an explanation on how the different numbers are generated and how one can get the numbers without creating another snapshot purely for that purpose. (Numbers such as did, id, etc)
An example is: In note_models, templs, there is a field called "did". I only managed to figure out what "did" is by comparing two different files and then recognising that the template in question indeed has a default id defined.
A large portion of the fields are created by Anki itself (for instance, quickly/without looking it up, I'm ~90% sure that did is) and simply exported by CrowdAnki (from what I remember CrowdAnki generally errs on the side of exporting internal Anki fields, with the assumption that they're usually both important and valuable in a shared context, only excluding some). Looking up the fields in more general resources often works well — in the past, the AnkiDroid database wiki page has been useful for me.
That said, yes, it'd definitely be valuable to document all these fields including those "inherited" from Anki!
Ah, I was unaware of the existing documentation. Thanks for pointing that out. Perhaps when I have more time, I'll look into helping out in the documentation process. Looking forward to this. Also, is there any estimate on how long it will take to create this documentation?
Also, do you happen to have a discord account? If so, could you share that? I'd like to talk with somebody experienced with this so that I can clarify things easier.
Also, is there any estimate on how long it will take to create this documentation?
Sorry, absolutely no promises!
Also, do you happen to have a discord account? If so, could you share that?
I don't have a discord, but please feel free to comment here or e-mail me.