Skip to content

Commit f4cb369

Browse files
committed
docs: fix broken links in documentation
1 parent 76df979 commit f4cb369

File tree

6 files changed

+18
-18
lines changed

6 files changed

+18
-18
lines changed

docs/recipes/console.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,4 +88,4 @@ Description of replay option is as follows:
8888
| key | default | description |
8989
| ------------ | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
9090
| level | ['log','warn','error',...] | You can set this option to play levels of log you need. |
91-
| replayLogger | a console based object that implements the interface [ReplayLogger](../../packages/rrweb/src/plugins/console/replay/index.ts#L13) | You can also set a replay logger to replay the log messages in a simulated browser console by implementing the interface `ReplayLogger` |
91+
| replayLogger | a console based object that implements the interface [ReplayLogger](../../packages/plugins/rrweb-plugin-console-replay/src/index.ts#L14) | You can also set a replay logger to replay the log messages in a simulated browser console by implementing the interface `ReplayLogger` |

docs/recipes/console.zh_CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,4 +87,4 @@ replayer.play();
8787
| key | 默认值 | 功能 |
8888
| ------------ | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
8989
| level | ['log','warn','error',...] | 你可以只播放想要的 console 函数类型 |
90-
| replayLogger | 一个基于 console 的对接口[ReplayLogger](../../packages/rrweb/src/plugins/console/replay/index.ts#L13)的实现 | 你也可以通过传入一个`ReplayLogger`接口的自己的实现,用 html 模拟一个浏览器控制台,来播放录制的 console 数据 |
90+
| replayLogger | 一个基于 console 的对接口[ReplayLogger](../../packages/plugins/rrweb-plugin-console-replay/src/index.ts#L14)的实现 | 你也可以通过传入一个`ReplayLogger`接口的自己的实现,用 html 模拟一个浏览器控制台,来播放录制的 console 数据 |

docs/recipes/dive-into-event.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ type -> EventType.Custom
2828
event -> customEvent
2929
```
3030

31-
The EventType is Typescript's numeric enum, which is a self-increased number from 0 in runtime. You can find its definition in this [list](https://github.com/rrweb-io/rrweb/blob/9488deb6d54a5f04350c063d942da5e96ab74075/src/types.ts#L10).
31+
The EventType is Typescript's numeric enum, which is a self-increased number from 0 in runtime. You can find its definition in this [list](../../packages/types/src/index.ts#L1).
3232

3333
In these kinds of events, the incrementalSnapshotEvent is the event that contains incremental data. You can use `event.data.source` to find which kind of incremental data it belongs to:
3434

@@ -67,4 +67,4 @@ source -> IncrementalSource.Font
6767
data -> fontData
6868
```
6969

70-
enum IncrementalSource's definition can be found in this [list](https://github.com/rrweb-io/rrweb/blob/98e71cd0d23628cd1fbdbe47664a65748084c4a4/packages/types/src/index.ts#L69).
70+
enum IncrementalSource's definition can be found in this [list](../../packages/types/src/index.ts#L62).

docs/recipes/dive-into-event.zh_CN.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ type -> EventType.Custom
2828
event -> customEvent
2929
```
3030

31-
其中 EventType 是 Typescipt 的 numeric enum,在运行时是从 0 开始的数字,其类型定义详见[列表](https://github.com/rrweb-io/rrweb/blob/9488deb6d54a5f04350c063d942da5e96ab74075/src/types.ts#L10)
31+
其中 EventType 是 Typescipt 的 numeric enum,在运行时是从 0 开始的数字,其类型定义详见[列表](../../packages/types/src/index.ts#L1)
3232

3333
其中 incrementalSnapshotEvent 代表增量数据,其具体增量类型可以通过 `event.data.source` 字段进行判断:
3434

@@ -67,4 +67,4 @@ source -> IncrementalSource.Font
6767
data -> fontData
6868
```
6969

70-
enum IncrementalSource 的定义详见[列表](https://github.com/rrweb-io/rrweb/blob/master/src/types.ts#L64)
70+
enum IncrementalSource 的定义详见[列表](../../packages/types/src/index.ts#L62)

docs/recipes/plugin.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ The plugin API is designed to extend the function of rrweb without bump the size
44

55
# Available plugins
66

7-
- [@rrweb/rrweb-plugin-console-record](packages/plugins/rrweb-plugin-console-record): A plugin for recording console logs.
8-
- [@rrweb/rrweb-plugin-console-replay](packages/plugins/rrweb-plugin-console-replay): A plugin for replaying console logs.
9-
- [@rrweb/rrweb-plugin-sequential-id-record](packages/plugins/rrweb-plugin-sequential-id-record): A plugin for recording sequential IDs.
10-
- [@rrweb/rrweb-plugin-sequential-id-replay](packages/plugins/rrweb-plugin-sequential-id-replay): A plugin for replaying sequential IDs.
11-
- [@rrweb/rrweb-plugin-canvas-webrtc-record](packages/plugins/rrweb-plugin-canvas-webrtc-record): A plugin for stream `<canvas>` via WebRTC.
12-
- [@rrweb/rrweb-plugin-canvas-webrtc-replay](packages/plugins/rrweb-plugin-canvas-webrtc-replay): A plugin for playing streamed `<canvas>` via WebRTC.
7+
- [@rrweb/rrweb-plugin-console-record](../../packages/plugins/rrweb-plugin-console-record): A plugin for recording console logs.
8+
- [@rrweb/rrweb-plugin-console-replay](../../packages/plugins/rrweb-plugin-console-replay): A plugin for replaying console logs.
9+
- [@rrweb/rrweb-plugin-sequential-id-record](../../packages/plugins/rrweb-plugin-sequential-id-record): A plugin for recording sequential IDs.
10+
- [@rrweb/rrweb-plugin-sequential-id-replay](../../packages/plugins/rrweb-plugin-sequential-id-replay): A plugin for replaying sequential IDs.
11+
- [@rrweb/rrweb-plugin-canvas-webrtc-record](../../packages/plugins/rrweb-plugin-canvas-webrtc-record): A plugin for stream `<canvas>` via WebRTC.
12+
- [@rrweb/rrweb-plugin-canvas-webrtc-replay](../../packages/plugins/rrweb-plugin-canvas-webrtc-replay): A plugin for playing streamed `<canvas>` via WebRTC.
1313

1414
## Interface
1515

docs/recipes/plugin.zh_CN.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
# 可用插件
66

7-
- [@rrweb/rrweb-plugin-console-record](packages/plugins/rrweb-plugin-console-record):一个用于记录控制台日志的插件。
8-
- [@rrweb/rrweb-plugin-console-replay](packages/plugins/rrweb-plugin-console-replay):一个用于回放控制台日志的插件。
9-
- [@rrweb/rrweb-plugin-sequential-id-record](packages/plugins/rrweb-plugin-sequential-id-record):一个用于记录顺序 ID 的插件。
10-
- [@rrweb/rrweb-plugin-sequential-id-replay](packages/plugins/rrweb-plugin-sequential-id-replay):一个用于回放顺序 ID 的插件。
11-
- [@rrweb/rrweb-plugin-canvas-webrtc-record](packages/plugins/rrweb-plugin-canvas-webrtc-record):一个用于通过 WebRTC 流式传输 `<canvas>` 的插件。
12-
- [@rrweb/rrweb-plugin-canvas-webrtc-replay](packages/plugins/rrweb-plugin-canvas-webrtc-replay):一个用于通过 WebRTC 播放流式 `<canvas>` 的插件。
7+
- [@rrweb/rrweb-plugin-console-record](../../packages/plugins/rrweb-plugin-console-record):一个用于记录控制台日志的插件。
8+
- [@rrweb/rrweb-plugin-console-replay](../../packages/plugins/rrweb-plugin-console-replay):一个用于回放控制台日志的插件。
9+
- [@rrweb/rrweb-plugin-sequential-id-record](../../packages/plugins/rrweb-plugin-sequential-id-record):一个用于记录顺序 ID 的插件。
10+
- [@rrweb/rrweb-plugin-sequential-id-replay](../../packages/plugins/rrweb-plugin-sequential-id-replay):一个用于回放顺序 ID 的插件。
11+
- [@rrweb/rrweb-plugin-canvas-webrtc-record](../../packages/plugins/rrweb-plugin-canvas-webrtc-record):一个用于通过 WebRTC 流式传输 `<canvas>` 的插件。
12+
- [@rrweb/rrweb-plugin-canvas-webrtc-replay](../../packages/plugins/rrweb-plugin-canvas-webrtc-replay):一个用于通过 WebRTC 播放流式 `<canvas>` 的插件。
1313

1414
## 接口
1515

0 commit comments

Comments
 (0)