[Request]: API function call list

[dnaicker]

Documentation Request

A list of API function calls that can be used for Issuer, Wallet Owner and Provider

Version

0.2.x

Which platform are you most interested in for documentation?

• React Native
• Node.JS

Contribute (optional)

• Agree

[TimoGlastra]

Thanks for opening this @dnaicker!

Could you add some extra context on what you're looking for exactly? Are you looking for API docs of all available methods in the framework? This is something we'd like to add, but we haven't had the time to do so yet.

[djleonskennedy]

This is the most challenging either for new comers or experienced devs, absent of API docs. You always need to figure how to use a method from source, glad typing is helping a lot, contributing is also black box we don’t know your plans about how do you plan to provide documentation. Will it be generated docs from source or manually added? Can you give a hint about your roadmap about docs @TimoGlastra @2mau (sorry for tagging you, you’re the most active) because I would contribute a docs with pleasure

[berendsliedrecht]

Our initial thoughts, quite a while ago, was to generate the documentation and version it. IIRC we looked at some doc gen tools, but I don't recall any that stood out. Would be nice if there is something like a docusaurus integration for API documentation, but otherwise we might have to create something new an keep it under a new domain like api.aries.js.org. Feel free to come with alternatives as we have not discussed this for a while.