Docs are broken

[bakkot]

For example, the docs for getRoom don't link the Room type. If you search for Room the closest you can get is this page, which does not list any of the actual methods on Room (instead it lists a random non-exported function defined in that file, presumably because it happens to have a jsdoc).

I was hoping to find some documentation suggesting how I can get the rooms in a space. There don't appear to be any helper methods for it. The closest I can find is getStateEvents(EventType.SpaceChild), where EventType is a value I can only seem to get by requiring a file from inside the package (require('matrix-js-sdk/lib/@types/event')). Surely there's a better way? But if there is, the documentation certainly doesn't suggest it.

[tawandamoyo]

I'd really like to work on this but don't know where to start, anyone to provide pointers? @SimonBrandner @callahad

[dimitri-bourreau]

Hi! Is there anything planned to improve the documentation?

[malehacker]

Hello, I would like to make improvements to the documentation for this project.

[Johennes]

This works correctly in my testing