Description
The shared interfaces in src/types.ts lack JSDoc comments. Adding documentation to each exported interface and field helps new contributors understand the data model.
What to Do
Add /** ... */ JSDoc comments to all exported interfaces and their fields in src/types.ts:
PluginConfigPeerAnnouncementDiscoveredPeerRecordSignedMessage- etc.
Difficulty
Easy — documentation only, no logic changes. Good way to learn the type system.
Description
The shared interfaces in
src/types.tslack JSDoc comments. Adding documentation to each exported interface and field helps new contributors understand the data model.What to Do
Add
/** ... */JSDoc comments to all exported interfaces and their fields insrc/types.ts:PluginConfigPeerAnnouncementDiscoveredPeerRecordSignedMessageDifficulty
Easy — documentation only, no logic changes. Good way to learn the type system.