iota-wiki icon indicating copy to clipboard operation
iota-wiki copied to clipboard

Add topic for IOTA links / deep links

Open maxwellmattryan opened this issue 4 years ago • 3 comments

Describe the solution you'd like At the moment there is no documentation for deep links on the Wiki page. It's worth noting that since they affect multiple parts of the IOTA ecosystem, e.g. Firefly, DID, it's perhaps best if the information for them was in a singular place rather than being scattered among documentation pages for the different technologies.

A solution could be to create a section in "Build" specifically for explaining these deep links and how to use them / build on top of them. Here we could include sub-sections like Overview, Usage, Technical Specification. It would be good to demonstrate them by adding them as special links inside the pages for showing different functionalities.

We should add this under the Chrysalis 1.5 section in it's own section.

Additional context We are considering a rename to IOTA links as it may be clearer to the user or developer that it is really a deep link using the IOTA scheme.

I would not mind writing some of the documentation as it pertains to the IOTA links implementation / interaction in Firefly :)

maxwellmattryan avatar Oct 04 '21 19:10 maxwellmattryan

@maxwellmattryan do you still plan to work on this or want to find a writer who would like to do it?

Dr-Electron avatar Aug 20 '22 18:08 Dr-Electron

do you still plan to work on this or want to find a writer who would like to do it?

Hey @Dr-Electron, I would love to write the page for this still (I love technical writing). At the moment I'm swamped with Stardust work for Firefly, but my plan is to first get a community discussion going around deep links (will post an initial TIP discussion). We have a scheme right now that works, but IMO it would be very beneficial to properly standardize this, like EIP-681 or BIP-21.

Once that is more or less complete, I think we can write the documentation for the wiki and even publish a simple URL parser / builder library for the community to use, which ofc would be linked from the wiki (in my mind it makes sense for this library to be officially under the IF since it's protocol related).

I will have some more time after the next two weeks to properly get this into place 👍

maxwellmattryan avatar Aug 29 '22 19:08 maxwellmattryan

Hi @maxwellmattryan are you planning to contribute a TIP as part of the new Wallet? 😅 Otherwise I will try to also push this in IF. Still think it's worth it

Dr-Electron avatar Sep 04 '23 19:09 Dr-Electron