Document code with JSDoc comments in PCD packages and enhance README files

[cedoor]

The following is the TODO list of packages to document in order of priority.

Urgent:

• [x] #646
• [x] #700
• [ ] #698

Somewhat urgent

• [ ] Enhance README file and add JSDoc comments - passport-interface
• [ ] Enhance README file and add JSDoc comments - pcd-types
• [ ] Enhance README file and add JSDoc comments - passport-crypto
• [ ] Enhance README file and add JSDoc comments - passport-ui
• [ ] Enhance README file and add JSDoc comments - pcd-collection

Least urgent

• [ ] semaphore-identity-pcd
• [ ] semaphore-signature-pcd
• [ ] semaphore-group-pcd
• [ ] ethereum-group-pcd
• [ ] ethereum-ownership-pcd
• [ ] rsa-pcd
• [ ] rsa-image-pcd
• [ ] rln-pcd
• [ ] webauthn-pcd
• [ ] halo-nonce-pcd

[ichub]

@cedoor, which packages do you think we should start with? is this something you could work on with Jei?

[cedoor]

@cedoor, which packages do you think we should start with? is this something you could work on with Jei?

Yes, we can work on that. We could need some support from you or those who know the packages best, in order to write good documentation.

I think prioritizing packages that will be most used by devs might make sense (e.g. @pcd/passport-interface). What do you think?

Having a list ordered by priority would be great.

[ichub]

Here's an order that makes sense to me

most urgent

• eddsa-pcd
• eddsa-ticket-pcd
• zk-eddsa-ticket-pcd

somewhat urgent

• passport-interface
• pcd-types
• passport-crypto
• passport-ui
• pcd-collection

least urgent

• semaphore-identity-pcd
• semaphore-signature-pcd
• semaphore-group-pcd
• ethereum-group-pcd
• ethereum-ownership-pcd
• rsa-pcd
• rsa-image-pcd
• rln-pcd
• webauthn-pcd
• halo-nonce-pcd

[cedoor]

Great! Thank you 👍🏽