Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 5 commits into from
Oct 19, 2024

Conversation

Qjuh
Copy link
Contributor

@Qjuh Qjuh commented Sep 21, 2024

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

  • TypeParameters of class, interface, type alias or function used in one of their members now link to the type parameter declaration on their parent
  • moved the generation of builtinDocumentationLinks from the website to the generateSplitDocumentation script. needs to stay in website too for now to support loading already existing api.json files that don't have the links in them yet
  • default values show in the excerpt for parameters of methods/functions as well as properties of interfaces

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

Status and versioning classification:

  • I know how to update typings and have done so, or typings don't need updating
  • This PR only includes non-code changes, like changes to documentation, README, etc.

Copy link

vercel bot commented Sep 21, 2024

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) Visit Preview Oct 18, 2024 11:55pm
discord-js-guide ⬜️ Ignored (Inspect) Visit Preview Oct 18, 2024 11:55pm

@Qjuh Qjuh requested a review from a team as a code owner September 21, 2024 18:07
@Qjuh Qjuh requested a review from Jiralite September 21, 2024 18:07
@Qjuh Qjuh changed the title feat(website): links to type parameters, builtin doc links in api.json feat(website): links to type parameters, builtin doc links in api.json, default values in excerpts Sep 21, 2024
@Qjuh Qjuh changed the title feat(website): links to type parameters, builtin doc links in api.json, default values in excerpts feat(website): type parameters links, builtin doc links, default values Sep 21, 2024
Copy link

codecov bot commented Sep 21, 2024

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 ⚠️
apps/website/src/components/ParameterNode.tsx 0.00% 1 Missing ⚠️
Additional details and impacted files
@@           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 Coverage Δ
brokers 31.44% <ø> (ø)
builders 82.43% <ø> (+0.77%) ⬆️
collection 100.00% <ø> (ø)
formatters 97.47% <ø> (ø)
proxy 66.27% <ø> (ø)
rest 87.37% <ø> (ø)
util 41.42% <ø> (ø)
utilities 100.00% <ø> (ø)
voice 72.23% <ø> (ø)
website 0.00% <0.00%> (ø)
ws 36.21% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kodiakhq kodiakhq bot merged commit 3540c31 into discordjs:main Oct 19, 2024
24 checks passed
@Qjuh Qjuh deleted the docs/type-param-links branch November 15, 2024 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants