Documentation

[skyrover7]

@Johennes Is there any documentation available for this library? I do have access to the matrix rust docs, but this implementation has proven different in a number of ways. The example provided is pretty sparse as far as functionality.

I've been able to

• create a new user with backup forced and recovery keys generated.
• create a new encrypted room
• send an audio message
• ive confirmed this is working by logging into the element web client with my user and seeing the rooms and messages.

This has been a challenging process without documentation as I am referring to rust docs, matrix docs, and the generated types/functions from this repo. It is a lot of trial and error, on top of which there is major latency in building/rebuilding with expo/react native. Anything you can point me towards or a recommended way to see what functions are exposed, and what their expected usage looks like?

[Johennes]

You're not the first to ask and it's a valid complaint.

The Rust SDK docs won't be of much help, unfortunately. This library wraps the FFI crate of the Rust SDK which in turn wrap the actual Rust SDK. We're auto-generating the React Native library code which means there is a mechanical translation between the FFI crate's API and this library. The Rust SDK itself sits below that, however, with a largely different API.

The FFI crate itself is developed somewhat dynamically and mostly for Element X which is why it doesn't contain a lot of documentation.

The best starting point for documentation might be the Swift bindings. These are also auto-generated from the FFI crate and the syntax is somewhat similar to TypeScript. Based on what you described, it sounds as if you're already past what's documented there, however.

Beyond that there really is only reading the auto-generated TS files at the moment, sadly. 🫤

[skyrover7]

amazing, appreciate that, i definitely was looking at timeline and sync next, which are documented there so that helps.

do you think using something like https://typedoc.org/ could help at all in generating documentation?

[skyrover7]

I haven't vetted all of this, obviously, but thoughts? I had o3 deep research go through the TS files and generate.

React Native Matrix SDK – Reference Guide.pdf

[Johennes]

Using typedoc to extract something from the doc comments would probably be helpful. For the guide, I think a couple of actual usage examples, maybe directly in the example app might be sufficient?

[nils-kt]

Any update?

[Johennes]

I fear the situation on the docs hasn't changed yet.