Frappe/public/js/ internals documentation

Hi Frappe Team!

I am working on a few customizations and getting intimate with the frappe javascript internals at the moment and noticed there was not a lot of documentation for the javascript internals of the project.

I wouldn’t mind helping document some of these files while I study them if you guys are ok with that. Also, not sure if there is any preference or tools to pickup javascript documentation and generate doc files built into bench or frappe. Any guidelines on this?

3 Likes

@Felipe_Orellana Awesome :smile:

No just add simple notes on the top of the file or the function to start with.

I think that works best for now.

Maybe we can start a comprehensive API documentation sometime.

Send a PR with some samples before you make extensive changes.