Upgrade Storageideas for docuemntation improvement
Hi, new user here :)
before finding the better way to import my firefox bookmarks I had a look at the JS client API documentation and have some thoughts I want to share:
a) IMO the banner at https://www.zotero.org/support/dev/client_coding/javascript_api#api_methods could be improved by making the mentions of source files into links to the corresponding files at a prefered place in the web (e.g. github?). That would improve the clarity of the existing documentation and help anyone who tries to use the existing non-code documentation as a starting point while taking assumingly minimal effort.
In case someone who can wants to just implement that, let me help as far as I can: This is the mentions and corresponding links, in order of appearance in the banner - if there is thought behind it being like it is rather than like suggested, I'm very open and curious to hear about it :)
chrome/content/zotero/xpcom https://github.com/zotero/zotero/tree/main/chrome/content/zotero/xpcom
xpcom/data https://github.com/zotero/zotero/tree/main/chrome/content/zotero/xpcom/data
chrome/content/zotero https://github.com/zotero/zotero/tree/main/chrome/content/zotero
zoteroPane.js https://github.com/zotero/zotero/blob/main/chrome/content/zotero/zoteroPane.js
fileInterface.js https://github.com/zotero/zotero/blob/main/chrome/content/zotero/fileInterface.js
b) it made me think about how to best document the API and I have a rough idea in mind what would have helped me to do the thing I didn't have to do, so I wonder if there is a good place to understand better what is planned or being considered in that regard, also to better understand challanges with the matter? I'd like to listen first in that regard before sharing ideas that with knowledge of the context have obvious flaws and thus might be frustrating to read.
Best Regards :)
P.S.: thanks to everyone who shaped zotero into what it is today, from what I've seen so far I'm very much looking forward to using it and feel greatful for it existing :)
before finding the better way to import my firefox bookmarks I had a look at the JS client API documentation and have some thoughts I want to share:
a) IMO the banner at https://www.zotero.org/support/dev/client_coding/javascript_api#api_methods could be improved by making the mentions of source files into links to the corresponding files at a prefered place in the web (e.g. github?). That would improve the clarity of the existing documentation and help anyone who tries to use the existing non-code documentation as a starting point while taking assumingly minimal effort.
In case someone who can wants to just implement that, let me help as far as I can: This is the mentions and corresponding links, in order of appearance in the banner - if there is thought behind it being like it is rather than like suggested, I'm very open and curious to hear about it :)
chrome/content/zotero/xpcom https://github.com/zotero/zotero/tree/main/chrome/content/zotero/xpcom
xpcom/data https://github.com/zotero/zotero/tree/main/chrome/content/zotero/xpcom/data
chrome/content/zotero https://github.com/zotero/zotero/tree/main/chrome/content/zotero
zoteroPane.js https://github.com/zotero/zotero/blob/main/chrome/content/zotero/zoteroPane.js
fileInterface.js https://github.com/zotero/zotero/blob/main/chrome/content/zotero/fileInterface.js
b) it made me think about how to best document the API and I have a rough idea in mind what would have helped me to do the thing I didn't have to do, so I wonder if there is a good place to understand better what is planned or being considered in that regard, also to better understand challanges with the matter? I'd like to listen first in that regard before sharing ideas that with knowledge of the context have obvious flaws and thus might be frustrating to read.
Best Regards :)
P.S.: thanks to everyone who shaped zotero into what it is today, from what I've seen so far I'm very much looking forward to using it and feel greatful for it existing :)
I would also like to work on an improved documentation :)
Did bash my head against the API multiple times already to get my things working.
Is there a way to work collaboratively on a draft?