docs: Rework of the Presence reference page #1062
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
itsmeeudrino
commented
Jul 28, 2024
apps/docs/reference/presence.md
Outdated
Comment on lines
8
to
11
| The [`Presence`](#presence) class represents a client, which can be used to interact with the PreMiD extension. | ||
|
|
||
| ### Example | ||
|
|
||
| ```javascript | ||
| It also provides lifecycle events via [`UpdateData`](#update_data) and [`iFrameData`](#iframe_data). |
There was a problem hiding this comment.
I spent some time trying to better explain what the Presence class does, from my understanding it is like an SDK to communicate with the PreMiD extension, with extra utilites for translations and DOM access.
maybe can be explained differently idk
apps/docs/reference/presence.md
Outdated
| ## constructor(options: [`PresenceOptions`](#presence-options)) {#constructor} | ||
|
|
||
|
|
||
| ## setActivity(data: [`PresenceData`](#presence-data) | [`Slideshow`](#slideshow)) |
There was a problem hiding this comment.
i've thought maybe we should add an example with DOM stuff, but maybe it's better to leave it to the Guide section instead
apps/docs/reference/presence.md
Outdated
| type: ActivityType.Watching, | ||
| details: "The Best Speedtech Cup of The Day in 2024!", | ||
| state: "WirtualTV", | ||
| largeImageKey: "<thumbnail_url>", |
DarkVillager
suggested changes
Jul 29, 2024
apps/docs/reference/presence.md
Outdated
|
|
||
| - `event` (`string`): The event to listen to. | ||
| This property is required to make your presence work, because it uses your application id to display its logo and assets. |
There was a problem hiding this comment.
This isn't true, should be more smth like this (or smth else)
Suggested change
| This property is required to make your presence work, because it uses your application id to display its logo and assets. | |
| This property is required to make your presence work, because it uses your application id to identify its self to discord. |
apps/docs/reference/presence.md
Outdated
|
|
||
| - `event` (`string`): The event to listen to. | ||
| This property is required to make your presence work, because it uses your application id to display its logo and assets. | ||
| You can get it on your [applications page](https://discordapp.com/developers/applications) |
There was a problem hiding this comment.
Also this?
Suggested change
| You can get it on your [applications page](https://discordapp.com/developers/applications) | |
| You can get it on your [applications page](https://discordapp.com/developers/applications) | |
| Here you can create an application. Make sure to give it the same name as the service, because if there's no name set in the presenceData it defaults to the application name. |
DarkVillager
suggested changes
Aug 4, 2024
|
|
||
| Example | ||
|
|
||
| ```ts{4-5} |
There was a problem hiding this comment.
These numbers are used for line highlights
There was a problem hiding this comment.
this is an extended markdown file, to preview check the deployed build in inital comment
|
|
||
| Creates a new `Presence` instance. | ||
| ```ts{16} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is a WIP that aims to improve the docs' Presence reference page
There's some methods still missing, however i wanted to share what i've done so far.
any kind of feedback would be very appreciated!
preview deployment: https://docs.pmd.eudrino.crun.zip/reference/presence.html