react-native-iap icon indicating copy to clipboard operation
react-native-iap copied to clipboard

docs: update documentation to match latest API

Open jeremybarbet opened this issue 3 years ago • 2 comments

jeremybarbet avatar Aug 06 '22 23:08 jeremybarbet

@jeremybarbet what are your thoughts on using https://typedoc.org/ to generate the docs vs separately maintaining it?

andresesfm avatar Aug 12 '22 22:08 andresesfm

I looked into it when starting this task and try this plugin for docusaurus but I wasn't really convinced.

An example I have in mind, is for MST, I love MST, but in my opinion the typedoc documentation is just unreadable and non-human example friendly. I rather dig into the code to find what I need.

Ideally if this jsdoc: Screenshot 2022-08-15 at 08 13 46

could generate a single markdown page like this, that would be the dream Screenshot 2022-08-15 at 08 14 28

But I didn't find anything like that, at least not yet. I was also thinking to write our own code parser to create the documentation, but probably a lot of work.

So in short, I'm not against it, but I didn't find the library that answer this problematic

jeremybarbet avatar Aug 15 '22 08:08 jeremybarbet

@jeremybarbet any chance we could get this merged?

andresesfm avatar Sep 06 '22 16:09 andresesfm

Closing in favor or version resolving conflicts: https://github.com/dooboolab/react-native-iap/pull/1927

andresesfm avatar Sep 06 '22 16:09 andresesfm