Skip to content
This repository has been archived by the owner on Jan 30, 2024. It is now read-only.

Link SDK docs to Matrix client-server documentation #86

Open
niklaslong opened this issue Nov 1, 2020 · 0 comments
Open

Link SDK docs to Matrix client-server documentation #86

niklaslong opened this issue Nov 1, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@niklaslong
Copy link
Owner

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 niklaslong added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Nov 1, 2020
@niklaslong niklaslong removed the help wanted Extra attention is needed label Nov 1, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant