chore(deps): update docusaurus monorepo to v3 (major) (#173)

* chore(deps): update docusaurus monorepo to v3 * chore: bump react and node * chore: fix mdx errors * chore: update readme --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: iProdigy <[email protected]> Co-authored-by: iProdigy <[email protected]>
twitch4j · Nov 16, 2023 · 12b4cec · 12b4cec
1 parent 56110c2
commit 12b4cec
Show file tree

Hide file tree

Showing 6 changed files with 3,819 additions and 2,418 deletions.
diff --git a/docs/package.json b/docs/package.json
@@ -14,21 +14,21 @@
     "write-heading-ids": "docusaurus write-heading-ids"
   },
   "dependencies": {
-    "@docusaurus/core": "2.4.3",
-    "@docusaurus/preset-classic": "2.4.3",
+    "@docusaurus/core": "3.0.0",
+    "@docusaurus/preset-classic": "3.0.0",
     "@emotion/react": "11.11.1",
     "@emotion/styled": "11.11.0",
-    "@mdx-js/react": "1.6.22",
+    "@mdx-js/react": "3.0.0",
     "@mui/icons-material": "5.14.18",
     "@mui/material": "5.14.18",
     "@philippheuer/docusaurus-components": "0.3.2",
     "clsx": "2.0.0",
     "prism-react-renderer": "2.2.0",
-    "react": "17.0.2",
-    "react-dom": "17.0.2"
+    "react": "18.2.0",
+    "react-dom": "18.2.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.4.3"
+    "@docusaurus/module-type-aliases": "3.0.0"
   },
   "browserslist": {
     "production": [
@@ -43,6 +43,6 @@
     ]
   },
   "engines": {
-    "node": ">=16.14"
+    "node": ">=18.0"
   }
 }
diff --git a/docs/versioned_docs/version-1.x/contribution/code-documentation.md b/docs/versioned_docs/version-1.x/contribution/code-documentation.md
@@ -15,7 +15,7 @@ When writing javadoc comments please follow this guideline:
  - Include all relevant tags (@param, @return, etc) for each method; without them, the method Javadoc is incomplete.
  - Start a method description with Returns, if the method returns a value.
  - Don’t explicitly refer to collections in descriptions (e.g., list of articles). Use, instead, the plural (e.g., the articles) or “all the” (e.g., all the articles).
- - When referring to another class, create a link by using {@link entity} (e.g., {@link TwitchClient}) 
+ - When referring to another class, create a link by using `{@link entity}` (e.g., `{@link TwitchClient}`) 
  - Begin boolean parameter descriptions with whether.
  - Describe exceptions (e.g., @throws) in past tense.
 

diff --git a/docs/versioned_docs/version-1.x/contribution/release.md b/docs/versioned_docs/version-1.x/contribution/release.md
@@ -22,15 +22,13 @@ The project contains a GH_TOKEN thats used to create new GitHub Releases using t
 
 To generate a human readable changelog, the commits have to follow the following naming convention:
 
-{{< col "12" "md-8" "xl-8" >}}
-| Commit Message | Changelog Category |
-|-------------:|:-----------------|
-| `feature:` | Features |
-| `feat:` | Features |
-| `fix:` | Bug Fixes |
-| `bugfix:` | Bug Fixes |
-| `perf:` | Performance Improvements |
-| `refactor:` | Code Refactoring |
-| `chore:` | Internal |
-| `docs:` | Documentation |
-{{</ col >}}
+| Commit Message | Changelog Category       |
+|---------------:|:-------------------------|
+|     `feature:` | Features                 |
+|        `feat:` | Features                 |
+|         `fix:` | Bug Fixes                |
+|      `bugfix:` | Bug Fixes                |
+|        `perf:` | Performance Improvements |
+|    `refactor:` | Code Refactoring         |
+|       `chore:` | Internal                 |
+|        `docs:` | Documentation            |
diff --git a/docs/versioned_docs/version-1.x/rest-helix/bits-leaderboard.mdx b/docs/versioned_docs/version-1.x/rest-helix/bits-leaderboard.mdx
@@ -36,7 +36,7 @@ HystrixCommand<BitsLeaderboard> getBitsLeaderboard(
 | Name          | Type      | Description  |
 | ------------- |:---------:| -----------------:|
 | count     | string    | Number of results to be returned. Maximum: 100. Default: 10. |
-| period         | string    | Time period over which data is aggregated (PST time zone). This parameter interacts with `started_at`. Valid values are given below. Default: `"all"`.<br /><br />"day" – 00:00:00 on the day specified in started_at, through 00:00:00 on the following day.<br /*"week" – 00:00:00 on Monday of the week specified in started_at, through 00:00:00 on the following Monday.<br />"month" – 00:00:00 on the first day of the month specified in started_at, through 00:00:00 on the first day of the following month.<br />"year" – 00:00:00 on the first day of the year specified in started_at, through 00:00:00 on the first day of the following year.<br />"all" – The lifetime of the broadcaster's channel. If this is specified (or used by default), started_at is ignored. |
+| period         | string    | Time period over which data is aggregated (PST time zone). This parameter interacts with `started_at`. Valid values are given below. Default: `"all"`.<br /><br />"day" – 00:00:00 on the day specified in started_at, through 00:00:00 on the following day.<br />"week" – 00:00:00 on Monday of the week specified in started_at, through 00:00:00 on the following Monday.<br />"month" – 00:00:00 on the first day of the month specified in started_at, through 00:00:00 on the first day of the following month.<br />"year" – 00:00:00 on the first day of the year specified in started_at, through 00:00:00 on the first day of the following year.<br />"all" – The lifetime of the broadcaster's channel. If this is specified (or used by default), started_at is ignored. |
 | started_at         | string    | Timestamp for the period over which the returned data is aggregated. Must be in RFC 3339 format. If this is not provided, data is aggregated over the current period; e.g., the current day/week/month/year. This value is ignored if period is "all".<br /><br />Any + operator should be URL encoded.<br /><br />Currently, the HH:MM:SS part of this value is used only to identify a given day in PST and otherwise ignored. For example, if the started_at value resolves to 5PM PST yesterday and period is "day", data is returned for all of yesterday. |
 | user_id         | string    | ID of the user whose results are returned; i.e., the person who paid for the Bits.<br/>As long as count is greater than 1, the returned data includes additional users, with Bits amounts above and below the user specified by user_id.<br />If user_id is not provided, the endpoint returns the Bits leaderboard data across top users (subject to the value of count). |