matrix-elixir-sdk icon indicating copy to clipboard operation
matrix-elixir-sdk copied to clipboard

Link SDK docs to Matrix client-server documentation

Open niklaslong opened this issue 5 years ago • 0 comments

Currently the function docs for the Request module don't link to the corresponding endpoints in the client-server docs. Suggestions in how to better organise documentation are welcome, my current thinking is having the endpoint path as the first line (linked to the Matrix docs for that endpoint) would make it easier to navigate, e.g. server_capabilities:

Screenshot 2020-11-01 at 14 41 45

A developer searching for a function to query an endpoint would be able to search by endpoint path as well. In the detailed view of a function, we could then move the description below that to give more context:

Screenshot 2020-11-01 at 14 44 23

niklaslong avatar Nov 01 '20 13:11 niklaslong