feat: add social service docs #233
Conversation
Deploying with
|
| Latest commit: |
ff873a1
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://41d0b673.new-docs-6m4.pages.dev |
| Branch Preview URL: | https://feat-add-social-client.new-docs-6m4.pages.dev |
|
|
||
| ### URLs | ||
|
|
||
| #### .zone Domain |
There was a problem hiding this comment.
I would add a comment about these being dev servers
| - [REST API](https://social.decentraland.zone) | ||
| - [WebSocket API](https://rpc-social.decentraland.zone) | ||
|
|
||
| #### .org Domain |
There was a problem hiding this comment.
Same as above but clarifying these are for production env
|
|
||
| ## Description | ||
|
|
||
| The authentication process for the Social Service involves interacting with the Matrix server. Users must log in to Matrix using their address, signing a fetch operation to obtain an authentication token. This token is then used to authorize interactions with the Social Service. |
There was a problem hiding this comment.
Clarify Matrix is the underlying chat platform.
| The authentication process for the Social Service involves interacting with the Matrix server. Users must log in to Matrix using their address, signing a fetch operation to obtain an authentication token. This token is then used to authorize interactions with the Social Service. | |
| The authentication process for the Social Service involves interacting with the [Matrix server](https://matrix.org/), used under the hood for the private chat subsystem. Users must log in to Matrix using their address, signing a fetch operation to obtain an authentication token. This token is then used to authorize interactions with the Social Service. |
| } | ||
| ``` | ||
|
|
||
| The authentication token, present in the access_token field, is required for subsequent interactions with the Social Service. |
There was a problem hiding this comment.
nit:
| The authentication token, present in the access_token field, is required for subsequent interactions with the Social Service. | |
| The authentication token, present in the `access_token` field, is required for subsequent interactions with the Social Service. |
|
|
||
| ## HTTP Request | ||
|
|
||
| To acquire the authentication token, a POST request must be made to the following URL: `https://social.decentraland.org/_matrix/client/r0/login` |
There was a problem hiding this comment.
We can add here that for this we need to create and sign a message with AuthChain and link to the docs section.
Also comment that a more complete example will be shown below to understand how it's used.
| import fetch from 'cross-fetch' | ||
| import { AuthIdentity, Authenticator } from '@dcl/crypto' | ||
|
|
||
| export async function getSynapseToken(synapseUrl: string, address: string, identity: AuthIdentity): Promise<string> { |
There was a problem hiding this comment.
We could mention somewhere what Synapse is or rename these to Matrix to avoid confusion.
| @@ -0,0 +1,89 @@ | |||
| --- | |||
There was a problem hiding this comment.
Not sure why but I see this section twice in the preview.
| --- | ||
| title: Login | ||
| url: /contributor/social-service/login | ||
| weight: 2 |
There was a problem hiding this comment.
Let's change these weights to have a proper order in the section. WDYT?
| @@ -0,0 +1,92 @@ | |||
| --- | |||
| title: Javascript Client | |||
| url: /contributor/social-service/login | |||
There was a problem hiding this comment.
this URL is duplicated with another doc, each one needs to be unique or it will be impossible to reach one of the two docs
| @@ -0,0 +1,69 @@ | |||
| --- | |||
| title: List friendships, requests and mutual friends | |||
There was a problem hiding this comment.
I would make this title shorter, remember that this title displays on the right-hand margin, and will look kind of bad if it won't fit in one line
| url: /contributor/social-service/ws | ||
| weight: 1 | ||
| --- | ||
| # WS Implementation API for Social Service |
There was a problem hiding this comment.
This top level title is not necessary,
The text from the field "title" is shown as a top level title automatically, so you will end up with two large titles
| --- | ||
| # WS Implementation API for Social Service | ||
|
|
||
| ## Description |
There was a problem hiding this comment.
For consistency with other pages, I wouldn't add a "description" title. It's already implicit that the first paragraph at the start of the doc is a high level description of what the rest of the doc is about
| weight: 4 | ||
| --- | ||
|
|
||
| # Social Service Get Friendships API Documentation |
There was a problem hiding this comment.
Please remove all page header titles, because they end up redundant. The text from the "title" field goes automatically both to the index and to the page header
adapt docs add link to client doc improve docs fix style fix title improve login docs fix style remove redundant titles
agusaldasoro
force-pushed
the
feat/add-social-client
branch
from
97401b0
to
ff873a1
Compare
Add documentation to build a Social Service Client