discordjs / discord.js

A powerful JavaScript library for interacting with the Discord API
https://discord.js.org
Apache License 2.0
25.44k stars 3.97k forks source link

feat(website): type parameters links, builtin doc links, default values #10515

Closed Qjuh closed 1 month ago

Qjuh commented 1 month ago

Please describe the changes this PR makes and why it should be merged:

Also fixed two minor doc related nits in discord.js.

Status and versioning classification:

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Skipped Deployments | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **discord-js** | ⬜️ Ignored ([Inspect](https://vercel.com/discordjs/discord-js/BBLXiCg8D5SSZCYFxSEpQoAMBbGo)) | [Visit Preview](https://discord-js-git-fork-qjuh-docs-type-param-links-discordjs.vercel.app) | | Oct 18, 2024 11:55pm | | **discord-js-guide** | ⬜️ Ignored ([Inspect](https://vercel.com/discordjs/discord-js-guide/DCFTZgPY9HgXxgLSEwx3BKZDqy5A)) | [Visit Preview](https://discord-js-guide-git-fork-qjuh-docs-type-param-links-discordjs.vercel.app) | | Oct 18, 2024 11:55pm |
codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 0% with 8 lines in your changes missing coverage. Please review.

Project coverage is 38.01%. Comparing base (24128a3) to head (885bc51). Report is 13 commits behind head on main.

Files with missing lines Patch % Lines
apps/website/src/components/PropertyNode.tsx 0.00% 7 Missing :warning:
apps/website/src/components/ParameterNode.tsx 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #10515 +/- ## ======================================= Coverage 38.00% 38.01% ======================================= Files 239 239 Lines 15488 15471 -17 Branches 1367 1353 -14 ======================================= - Hits 5886 5881 -5 + Misses 9587 9575 -12 Partials 15 15 ``` | [Flag](https://app.codecov.io/gh/discordjs/discord.js/pull/10515/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=discordjs) | Coverage Δ | | |---|---|---| | [brokers](https://app.codecov.io/gh/discordjs/discord.js/pull/10515/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=discordjs) | `31.44% <ø> (ø)` | | | [builders](https://app.codecov.io/gh/discordjs/discord.js/pull/10515/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=discordjs) | `82.43% <ø> (+0.77%)` | :arrow_up: | | [collection](https://app.codecov.io/gh/discordjs/discord.js/pull/10515/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=discordjs) | `100.00% <ø> (ø)` | | | [formatters](https://app.codecov.io/gh/discordjs/discord.js/pull/10515/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=discordjs) | `97.47% <ø> (ø)` | | | [proxy](https://app.codecov.io/gh/discordjs/discord.js/pull/10515/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=discordjs) | `66.27% <ø> (ø)` | | | [rest](https://app.codecov.io/gh/discordjs/discord.js/pull/10515/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=discordjs) | `87.37% <ø> (ø)` | | | [util](https://app.codecov.io/gh/discordjs/discord.js/pull/10515/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=discordjs) | `41.42% <ø> (ø)` | | | [utilities](https://app.codecov.io/gh/discordjs/discord.js/pull/10515/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=discordjs) | `100.00% <ø> (ø)` | | | [voice](https://app.codecov.io/gh/discordjs/discord.js/pull/10515/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=discordjs) | `72.23% <ø> (ø)` | | | [website](https://app.codecov.io/gh/discordjs/discord.js/pull/10515/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=discordjs) | `0.00% <0.00%> (ø)` | | | [ws](https://app.codecov.io/gh/discordjs/discord.js/pull/10515/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=discordjs) | `36.21% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=discordjs#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.