chore: add additional jsdoc annotations for discovery module

[achou11]

Addresses #20

So far:

• accidentally pushed 66b56ee to main but that would've been part of this too 😅
• descriptions for methods of classes
• example annotations
• descriptions about classes

What's left:

• descriptions about classes
• example annotations

[achou11]

@sethvincent working through adding examples and a couple of questions come up:

• Is it safe to assume that for methods, we only add an example for the public ones?
• How detailed should the examples be? Trying to balance between "detailed enough to basically copy-paste and have full-context" and "reduce noise caused by boilerplate and highlight the important bits". Any thoughts on what approach we should go with, or will it depend on what's being documented?

[sethvincent]

It would be useful to list relevant methods for creating identities here and maybe link to their spot in the docs (not sure off the top of my head if that's possible from within example code using typedoc, so maybe this note would be outside the code block).

[achou11]

Yeah makes sense! Another idea: not sure how it would look in the generated output but could put a (collapsible?) snippet for an example of creating the identity, as a footnote type of thing that can be referenced from here. Maybe too complicated so probably stick with your idea

[sethvincent]

Yeah only public methods.

I think we should lean toward minimal examples as much as possible. The examples you've added so far look pretty good to me. I just added one comment about referencing/linking to related methods that would add too much boilerplate in a method's example.