• Keyoxide
  • xmpp documentation improvement request

Regarding the xmpp documentation at...

https://docs.keyoxide.org/service-providers/xmpp/

"Optional: instructions to work with OMEMO"

As written, and I may be a simpleton, but the XMPP_ID directions can be confusing:


The resulting URI should look something like:

xmpp:XMPP_ID?omemo-sid-123456789=A1B2C3D4E5F6G7H8I9

This is what you will use as claim in the next section.
Add the claim…

The claim looks as follows:

xmpp:XMPP_ID

Make sure to replace XMPP_ID.


As written, XMPP_ID is an explicit variable name with the contents defined as "omemo-sid-123456789=A1B2C3D4E5F6G7H8I9".

This will be confusing to some readers. It would be helpful to include an actual example with a faked but realistic value for the "XMPP_ID" string in

xmpp:XMPP_ID

A reader would want to know precisely how to replace the "XMPP_ID" string. Would it include the variable contents beyond the question mark? Or should it just be the xmpp address/log-in, without the question mark and string beyond it?

Too many logical possibilities will cause users to try a variety of combinations and eventually give up and run away.