Extension library docs

[ChrisChinchilla]

fixes KILTProtocol/ticket#2801

Moves Extention library read me to documentation.

Checklist:

• I have verified that the code works
• I have verified that the code is easy to understand
  • If not, I have left a well-balanced amount of inline comments
• I have left the code in a better state
• I have documented the changes (where applicable)
  • Either PR or Ticket to update the Docs
  • Link the PR/Ticket here

[ChrisChinchilla]

Link checker is breaking and I'm not sure why

[rflechtner]

Looks good overall! We should probably try, test, and publish the library before we publish the docs, right?
Also I'm wondering whether it makes sense to introduce a clear distinction between functions intended for application developers and those targeting wallet (extension) implementers

[ChrisChinchilla]

@rflechtner Made some changes…

I'm wondering whether it makes sense to introduce a clear distinction between functions intended for application developers and those targeting wallet (extension) implementers

Are you saying there's probably more that needs documenting in addition to what's here already?

[rflechtner]

Are you saying there's probably more that needs documenting in addition to what's here already?

What I'm hinting at is that different functions are meant for use in different environments; verifyDidConfigResource for example is something that would be called by a browser extension, createCredential and didConfigResourceFromCredential are meant to be used in a backend implementation, and initializeKiltExtensionAPI´ & getExtensions` etc. would be called in the frontend. We haven't pointed that out anywhere, and it could help with understanding the use and purpose of this library.

[Ad96el]

LGTM in general. I'm just wondering why the messaging part is missing. Messaging is crucial for interacting with the extension. Is it not the scope of this PR?

[ChrisChinchilla]

@Ad96el It was never in the docs I took over, I kind of knew that there were methods missing. If you say it's essential, then we can add before merging.

[Ad96el]

Seems like I forgot to update the README. 😕
Will tackle it today.

[ChrisChinchilla]

@Ad96el This read me? https://github.com/KILTprotocol/kilt-extension-api/blob/main/README.md

I think we're stuck in a dependency loop as we can't add a link until this is merged and we can't merge this until there's a release. I'm not sure if the extension library is that high-traffic, so we can probably leave it for now?