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.

Sign up for GitHub

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

chore(docs): docs add features page #105

Merged
merged 1 commit into from
Jan 11, 2024
Merged

chore(docs): docs add features page #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion document/docs/en/guide/start/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
["intro", "quick-start"]
["intro", "quick-start", "features"]
32 changes: 32 additions & 0 deletions document/docs/en/guide/start/features.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Features

Here you can learn about the main features supported by Rsdoctor.

## Build Overview

| Feature | Description | Related Links |
|------|------|------|
| Project Overview | View information such as the current project configuration and version | - |
| Artifact Overview | View information about the artifacts built for the current project | - |
| Compilation Overview | View data information about the current project's compilation process | - |
| Artifact Alert | The ability to perform detection based on build artifact data | - |
| Compilation Alert | The ability to perform detection based on compilation data | - |

## Compilation Analysis

| Feature | Description | Related Links |
|------|------|------|
| Loader Compilation Behavior Analysis | Loader analysis data in directory and file dimensions, displaying the compilation behavior of a single file at the same time | - |
| Loader Time Consumption Analysis | Execution sequence diagram of all Loaders in the current project | - |
| Resolver Analysis | Analysis data on Resolver parsing capabilities | - |
| Plugins Analysis | Data analysis of the plugins used in the project | - |


## Bundle Analysis

| Feature | Description | Related Links |
|------|------|------|
| Artifact Analysis | Analysis of the relationships between assets, chunks, and modules in the artifact, as well as the packaged code and size analysis of each module, etc. | - |
| Module Analysis | Analysis of module dependencies | - |
| Duplicate Package Inspection | Inspection of duplicate dependencies used in the project | - |
| Bundle Diff | Comparative analysis of two artifacts | Planned support |
2 changes: 1 addition & 1 deletion document/docs/zh/guide/start/_meta.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
["intro", "quick-start"]
["intro", "quick-start", "features"]
36 changes: 36 additions & 0 deletions document/docs/zh/guide/start/features.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# 功能导航

在这里，你可以了解到 Rsdoctor 支持的主要功能。

## 构建概览

| 功能 | 描述 | 相关链接 |
| --------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| 项目概览 | 查看当前项目配置、版本等信息 | - |
| 产物概览 | 查看当前项目构建产物的信息 | - |
| 编译概览 | 查看当前项目编译过程的数据信息 | - |
| 产物告警 | 基于构建产物数据做检测的能力 | - |
| 编译告警 | 基于编译数据做检测的能力 | -|


## 编译分析


| 功能 | 描述 | 相关链接 |
| --------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| Loader 编译行为分析 | 以目录与文件维度的 Loader 分析数据，同时展示单个文件编译行为 | - |
| Loaders 耗时分析 | 当前项目中所有 Loader 的执行时序图 | - |
| Resolver 分析 | Resolver 解析能力分析数据 | - |
| Plugins 分析 | 项目所使用插件的数据分析 | - |

## 构建产物分析


| 功能 | 描述 | 相关链接 |
| --------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| 产物分析 | 产物中 assets、chunks、modules 关系分析，以及每个 module 打包代码及大小分析等 | - |
| 模块分析 | Modules 依赖关系分析 | - |
| 重复包检查 | 检查项目使用的依赖包的重复情况。 | - |
| Bundle Diff | 两份产物对比分析 | 计划支持 |