Skip to content

Commit 79e7dd5

Browse files
dlymonkaidlymonkai
committed
Updated documentation to react 19
1 parent 95c5afa commit 79e7dd5

File tree

8 files changed

+39
-37
lines changed

8 files changed

+39
-37
lines changed

‎documentation/docs/v3-docs/apis/react-native/damage-annotation.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Set the background image opacity (works only if clip is `true`)
8989

9090
Set the style of the ellipse by defining the stroke's color and width
9191

92-
### ellipse.anchor.{ x | y | o }
92+
### ellipse.anchor.{`x`} | {`y`} | {`o`}
9393
`PropsTypes.shape({ color: PropsTypes.string, radius: PropsTypes.number })`
9494

9595
Set the color of the ellipse's anchor icon of the `x` or `y` axis or the origin `o`'s color and size

‎documentation/docs/v3-docs/monitoring.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,14 @@ The configuration options are listed below :
3232

3333
### Monitoring Config
3434

35-
| **Config option** | **Required** | **Type** | **Description** |
36-
| ------------------ | ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
37-
| `dsn` | ✓ | string | DSN (Data Source Name) key for sentry.io application. A DSN tells a Sentry SDK where to send events so the events are associated with the correct project. |
38-
| `environment` | ✓ | string | The current environment of your application , such as _development_, _testing_, _staging_, or _production_. Environments help you better filter issues and transactions among other uses. |
39-
| `debug` | ✓ | boolean | Enable debug functionality in the SDK itself. If debug is enabled SDK will attempt to print out useful debugging information in browser's console if something goes wrong with sending the event. |
40-
| `tracesSampleRate` | ✓ | number | Sample rate to determine trace sampling. The default is 1.0 which means that 100% of error events are sent. |
41-
| `tracingOrigins` | ✓ | string[] | Array of all the origin to browser trace |
42-
| `customTags` | | { [tag: string]: string } | Add custom tags in all transactions for better tracking |
35+
| **Config option** | **Required** | **Type** | **Description** |
36+
|--------------------|--------------|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
37+
| `dsn` | ✓ | `string` | DSN (Data Source Name) key for sentry.io application. A DSN tells a Sentry SDK where to send events so the events are associated with the correct project. |
38+
| `environment` | ✓ | `string` | The current environment of your application , such as _development_, _testing_, _staging_, or _production_. Environments help you better filter issues and transactions among other uses. |
39+
| `debug` | ✓ | `boolean` | Enable debug functionality in the SDK itself. If debug is enabled SDK will attempt to print out useful debugging information in browser's console if something goes wrong with sending the event. |
40+
| `tracesSampleRate` | ✓ | `number` | Sample rate to determine trace sampling. The default is 1.0 which means that 100% of error events are sent. |
41+
| `tracingOrigins` | ✓ | `string[]` | Array of all the origin to browser trace |
42+
| `customTags` | | `{ [tag: string]: string }` | Add custom tags in all transactions for better tracking |
4343

4444
### Note
4545

@@ -93,12 +93,12 @@ Where name is the module name for which we want to measure performance. Operatio
9393

9494
### SentryTransactionObject
9595

96-
| **Config option** | **Params** | **Description** |
97-
| ----------------- | ------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
98-
| `setTag` | name: string, value: string | Set tag in a transaction instance |
99-
| `startSpan` | op: string, data: { [key: string]: number \| string } \| null | Create a span in a transaction instance to measure the performance for a sub event |
100-
| `finishSpan` | op: string | Finish a running span in a transaction instance and complete the measurement for a sub event |
101-
| `finish` | status: string | Finish a running transaction instance and complete the measurement for a main event |
96+
| **Config option** | **Params** | **Description** |
97+
|-------------------|-----------------------------------------------------------------|----------------------------------------------------------------------------------------------|
98+
| `setTag` | `name: string, value: string` | Set tag in a transaction instance |
99+
| `startSpan` | `op: string, data: { [key: string]: number \| string } \| null` | Create a span in a transaction instance to measure the performance for a sub event |
100+
| `finishSpan` | `op: string` | Finish a running span in a transaction instance and complete the measurement for a sub event |
101+
| `finish` | `status: string` | Finish a running transaction instance and complete the measurement for a main event |
102102

103103
User can set tags, create new span and finish span & transaction at the end to send measured data to sentry. `capture.finish('Ok')`
104104

‎documentation/docusaurus.config.js‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
// @ts-check
22
// Note: type annotations allow type checking and IDEs autocompletion
33

4-
const lightCodeTheme = require('prism-react-renderer/themes/github');
5-
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
4+
const lightCodeTheme = require('prism-react-renderer').themes.github;
5+
const darkCodeTheme = require('prism-react-renderer').themes.dracula;
66

77
/** @type {import('@docusaurus/types').Config} */
88
const config = {
@@ -26,8 +26,7 @@ const config = {
2626
({
2727
docs: {
2828
sidebarPath: require.resolve('./sidebars.js'),
29-
editUrl:
30-
'https://github.com/monkvision/monkjs/blob/main/documentation/',
29+
editUrl: 'https://github.com/monkvision/monkjs/blob/main/documentation/',
3130
},
3231
theme: {
3332
customCss: require.resolve('./src/css/custom.css'),
@@ -69,9 +68,9 @@ const config = {
6968
position: 'left',
7069
label: 'Docs',
7170
},
72-
{ to: 'sights', label: 'Sights', position: 'left' },
73-
{ to: 'icons', label: 'Icons', position: 'left' },
74-
{ to: 'configValidator', label: 'Config Validator', position: 'left' },
71+
{ to: '/Sights', label: 'Sights', position: 'left' },
72+
{ to: '/Icons', label: 'Icons', position: 'left' },
73+
{ to: '/ConfigValidator', label: 'Config Validator', position: 'left' },
7574
{
7675
href: 'https://github.com/monkvision/monkjs',
7776
label: 'GitHub',

‎documentation/package.json‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,20 @@
1818
},
1919
"dependencies": {
2020
"@auth0/auth0-react": "^2.2.4",
21-
"@docusaurus/core": "2.4.3",
22-
"@docusaurus/plugin-content-pages": "^2.4.3",
23-
"@docusaurus/preset-classic": "2.4.3",
24-
"@docusaurus/theme-common": "^2.4.3",
25-
"@mdx-js/react": "^1.6.22",
21+
"@docusaurus/core": "3.9",
22+
"@docusaurus/plugin-content-pages": "^3.9",
23+
"@docusaurus/preset-classic": "^3.9",
24+
"@docusaurus/theme-common": "^3.9",
25+
"@mdx-js/loader": "^3.1.1",
26+
"@mdx-js/react": "^3.1.1",
2627
"@monkvision/common": "5.1.4",
2728
"@monkvision/common-ui-web": "5.1.4",
2829
"@monkvision/sights": "5.1.4",
2930
"@monkvision/types": "5.1.4",
3031
"clsx": "^1.2.1",
31-
"prism-react-renderer": "^1.3.5",
32-
"react": "^17.0.2",
33-
"react-dom": "^17.0.2",
32+
"prism-react-renderer": "^2.4.1",
33+
"react": "^19.1",
34+
"react-dom": "^19.1",
3435
"react-router-dom": "^6.22.3",
3536
"zod": "^3.23.8"
3637
},
@@ -41,7 +42,7 @@
4142
"@monkvision/eslint-config-typescript-react": "5.1.4",
4243
"@monkvision/prettier-config": "5.1.4",
4344
"@monkvision/svgo-config": "5.1.4",
44-
"@tsconfig/docusaurus": "^1.0.5",
45+
"@tsconfig/docusaurus": "^2.0.3",
4546
"@typescript-eslint/eslint-plugin": "^5.43.0",
4647
"@typescript-eslint/parser": "^5.43.0",
4748
"eslint": "^8.29.0",
@@ -57,7 +58,7 @@
5758
"eslint-plugin-react-hooks": "^4.6.0",
5859
"prettier": "^2.7.1",
5960
"svgo": "^3.0.2",
60-
"typescript": "^4.8.4"
61+
"typescript": "^5.9.2"
6162
},
6263
"browserslist": {
6364
"production": [

‎documentation/src/components/Sights/SightCard/SightCard.tsx‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@ import { DynamicSVGCustomizationFunctions } from '@monkvision/common-ui-web';
77
import { DynamicSVG } from '../../domOnly';
88
import styles from './SightCard.module.css';
99

10-
const vehicleModelDisplayOverlays: Record<Exclude<VehicleModel, VehicleModel.ALL>, string> = {
10+
const vehicleModelDisplayOverlays: Record<
11+
Exclude<VehicleModel, typeof VehicleModel.ALL>,
12+
string
13+
> = {
1114
[VehicleModel.AUDIA7]: sights['audia7-WKJlxkiF'].overlay,
1215
[VehicleModel.FESC20]: sights['fesc20-bD8CBhYZ'].overlay,
1316
[VehicleModel.FF150]: sights['ff150-7UI3m9B3'].overlay,

‎documentation/src/pages/ConfigValidator/index.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import React, { useState } from 'react';
1+
import { useState } from 'react';
22
import Layout from '@theme/Layout';
33
import { ConfigImport, ConfigValidateResults } from '@site/src/components';
44
import styles from './styles.module.css';

‎documentation/src/pages/index.tsx‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
22
import Layout from '@theme/Layout';
3-
import React, { JSX } from 'react';
43
import { HomeFeatures, HomeHeader } from '@site/src/components';
54

6-
export default function Home(): JSX.Element {
5+
export default function Home() {
76
const { siteConfig } = useDocusaurusContext();
87

98
return (

‎documentation/tsconfig.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"compilerOptions": {
55
"allowJs": true,
66
"esModuleInterop": true,
7-
"jsx": "react",
7+
"jsx": "react-jsx",
88
"lib": ["dom", "esnext"],
99
"module": "esnext",
1010
"noEmit": true,

0 commit comments

Comments
 (0)