source-academy/modules

Generated documentation missing each module's summary

Closed this issue · 0 comments

Modules user documentation used to include a general description of every module in that module's section of the documentation. These summaries come from the JSDoc comment at the top of the functions.ts file of each module bundle.

A recent change to the way documentation is generated has caused these summaries to no longer appear. Lee Yi has identified the possible point of regression as #153.

It is worth fixing as these summaries can be very informative and helpful. For example, curve's summary contains useful info like the definitions for curve, curve transformation, curve drawer, code snippets etc.