Update config.mts to fix links & add Delete post, typing, and ulist #16
Conversation
|
I know there is another pull request, but this one only fixes the links and does nothing else. |
I also moved some stuff around on the side bar, instead of having a list of all the cloudlink stuff, I think it is better to group it into packets (things the server sends), and commands (things the client sends to the server).
Finley224
changed the title
|
New addition: |
This comment was marked as off-topic.
This comment was marked as off-topic.
| @@ -8,4 +8,3 @@ | |||
| - The general request/response shape | |||
| --> | |||
|
|
|||
| This section is out of date. | |||
There was a problem hiding this comment.
This section is still out of date
There was a problem hiding this comment.
...which makes the rest of the added Cloudlink sections a little confusing as those are not out of date
There was a problem hiding this comment.
What about " this section is incomplete"?
There was a problem hiding this comment.
That would be misleading, information that is on here would contradict itself right now
There was a problem hiding this comment.
I added a list of the up to date sections, does that work?
docs/api/cloudlink/packets/ulist.md
Outdated
| ```ts [TypeScript] | ||
| // Converts the online userlist into a array of strings | ||
| // val is the string of users given by the websocket | ||
| let onlineUsers: string[] = val.split(";"); |
There was a problem hiding this comment.
The JS code works in Typescript as well and is more idiomatic
There was a problem hiding this comment.
Ok, I will merge them into one.
Co-Authored-By: mybearworld <[email protected]>
| This section is out of date. | ||
| - This page is out of date. | ||
|
|
||
| Up to date pages: |
There was a problem hiding this comment.
i don't really like this approach and again, something should update these
There was a problem hiding this comment.
I will update this when I get to it, just don't have time at the moment, do you have an idea on how the message should be written @williamhorning ?
There was a problem hiding this comment.
Actually, it seems as though most the only thing not up to date would be the authpswd page, which we could just add a notice box to. we should probably add a brief introduction to cloudlink on this page though
| This packet is sent when a client sends a typing indicator. These clients will be sent periodically by clients, so you need to setup a expiration system. | ||
| ### Client typing indicator frequency | ||
| - **meo**: 3 seconds | ||
| - **Roarer 2**: 3 seconds | ||
| - **Meower Svelte**: 4 seconds | ||
|
|
There was a problem hiding this comment.
| This packet is sent when a client sends a typing indicator. These clients will be sent periodically by clients, so you need to setup a expiration system. | |
| ### Client typing indicator frequency | |
| - **meo**: 3 seconds | |
| - **Roarer 2**: 3 seconds | |
| - **Meower Svelte**: 4 seconds | |
| This packet is sent when a client is currently typing. | |
again, client behavior shouldn't go here
There was a problem hiding this comment.
There should probably still be some sort of reference on what "periodically" means though.
There was a problem hiding this comment.
I disagree on this one, it's a helpful reference to have the typing times in the API docs as there is no standard for it. What if I remove the note about how to implement it but leave a general note of most clients send the packet at least every 4 seconds?
There was a problem hiding this comment.
the lack of standard is the problem here, but i'm not opposed to saying "send a typing indicator every few seconds" note
There was a problem hiding this comment.
Maybe say it expires after 4 seconds
There was a problem hiding this comment.
Maybe say it expires after 4 seconds
Only Meower Svelte seems to use that though
There was a problem hiding this comment.
Maybe say it expires after 4 seconds
Maybe say it expires after 4 seconds
Only Meower Svelte seems to use that though
I like the 4s idea, all the other ones seem to be less than 4s so 4s would work.
There was a problem hiding this comment.
does the 4s thing work for you @williamhorning?
There was a problem hiding this comment.
@Finley224 either saying "every four seconds" or saying "at an interval less than five seconds" is fine
Ok, when I'm back at my computer I will do that. |
|
I will fix the errors with the checks soon. |
Co-authored-by: William Horning <[email protected]>
Co-authored-by: Finley <[email protected]>
Co-authored-by: Finley <[email protected]>
|
merged this in d76ad95 |
The docs have broken links that go to the old mower media org and the wrong repos, this commit should fix that.