compose-us / flottform

A better UX for file uploads #build-in-public
https://github.com/compose-us/build-in-public/blob/main/README.md#ux-improvement-for-file-uploads-in-web-forms-working-title-flottform
1 stars 0 forks source link

Create API docs for published APIs #53

Open Narigo opened 2 months ago

Narigo commented 2 months ago

Description

We expose a few functions and types. All of this should be documented. If we document this with JSDoc, we should be able to generate nice API docs

Links / References

Tasks / Definition of Done

Further information

On the developer page, outlining the general usage and examples, this should be linked as well.

TamaraBogantseva commented 2 days ago

We will have another issue for improving the docs, but we need to publish this one in order to have some documentation