Skip to content

Commit a110da1

Browse files
authored
docs: revert README skills section from table to list format (#14)
1 parent 6d4ebc9 commit a110da1

File tree

1 file changed

+49
-23
lines changed

1 file changed

+49
-23
lines changed

README.md

Lines changed: 49 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,10 @@ A collection of Agent Skills for [Rstack](https://rspack.rs/guide/start/ecosyste
1414
## Table of Contents
1515

1616
- [Usage](#usage)
17-
- [Skills](#skills)
18-
- [Rspack](#rspack)
19-
- [Rsbuild](#rsbuild)
20-
- [Rspress](#rspress)
21-
- [Rsdoctor](#rsdoctor)
17+
- [Rspack Skills](#rspack-skills)
18+
- [Rsbuild Skills](#rsbuild-skills)
19+
- [Rspress Skills](#rspress-skills)
20+
- [Rsdoctor Skills](#rsdoctor-skills)
2221
- [Contributing](#contributing)
2322
- [License](#license)
2423

@@ -30,32 +29,59 @@ Install any skill with:
3029
npx skills add rstackjs/agent-skills --skill <skill-name>
3130
```
3231

33-
## Skills
32+
## Rspack Skills
3433

35-
### Rspack
34+
### rspack-debugging
3635

37-
| Skill | Description | Use When |
38-
| ------------------ | -------------------------------------------------------------------------------- | -------------------------------------------------------- |
39-
| `rspack-debugging` | Debug crashes or deadlocks/hangs in Rspack builds using LLDB | Encountering "Segmentation fault" errors or build hangs |
40-
| `rspack-tracing` | Diagnose Rspack build issues with crash identification and performance profiling | Build failures, slow builds, or performance optimization |
36+
```bash
37+
npx skills add rstackjs/agent-skills --skill rspack-debugging
38+
```
39+
40+
Helps Rspack users and developers debug crashes or deadlocks/hangs in the Rspack build process using LLDB.
41+
42+
Use this Skill when users encounter "Segmentation fault" errors during Rspack builds or when the build progress gets stuck.
43+
44+
### rspack-tracing
45+
46+
```bash
47+
npx skills add rstackjs/agent-skills --skill rspack-tracing
48+
```
49+
50+
Comprehensive guide and toolkit for diagnosing Rspack build issues. Quickly identify where crashes/errors occur, or perform detailed performance profiling to resolve bottlenecks.
4151

42-
### Rsbuild
52+
Use when the user encounters build failures, slow builds, or wants to optimize Rspack performance.
4353

44-
| Skill | Description | Use When |
45-
| -------------------- | -------------------------------------- | ---------------------------------------------------------------------- |
46-
| `rsbuild-v2-upgrade` | Migrate Rsbuild projects from v1 to v2 | Upgrading Rsbuild, updating configs/plugins, or validating the upgrade |
54+
## Rsbuild Skills
4755

48-
### Rspress
56+
### rsbuild-v2-upgrade
57+
58+
```bash
59+
npx skills add rstackjs/agent-skills --skill rsbuild-v2-upgrade
60+
```
4961

50-
| Skill | Description | Use When |
51-
| -------------------- | -------------------------------------- | ------------------------------------------------------------------------------ |
52-
| `rspress-v2-upgrade` | Migrate Rspress projects from v1 to v2 | Upgrading Rspress, updating packages/configs/themes, or validating the upgrade |
62+
Migrate Rsbuild projects from v1 to v2. Use when a user asks to upgrade Rsbuild, follow the v1-to-v2 guide, update configs/plugins, or validate the upgrade.
63+
64+
## Rspress Skills
65+
66+
### rspress-v2-upgrade
67+
68+
```bash
69+
npx skills add rstackjs/agent-skills --skill rspress-v2-upgrade
70+
```
71+
72+
Migrate Rspress projects from v1 to v2. Use when a user asks to upgrade Rspress, follow the v1-to-v2 guide, update packages/configs/themes, or validate the upgrade.
73+
74+
## Rsdoctor Skills
75+
76+
### rsdoctor-analysis
77+
78+
```bash
79+
npx skills add rstackjs/agent-skills --skill rsdoctor-analysis
80+
```
5381

54-
### Rsdoctor
82+
Analyze Rspack/Webpack bundles from local Rsdoctor build data. Provides intelligent analysis of chunk, module, package, and loader data. Provides evidence-based conclusions and actionable optimization recommendations.
5583

56-
| Skill | Description | Use When |
57-
| ------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
58-
| `rsdoctor-analysis` | Analyze Rspack/Webpack bundles for insights and optimizations | Analyzing bundle composition, duplicates, large chunks, side-effect modules, or for optimization recommendations |
84+
Use when you need to analyze bundle composition, identify duplicate packages, detect similar packages, find large chunks, analyze side effects modules, or get comprehensive bundle optimization recommendations.
5985

6086
## Contributing
6187

0 commit comments

Comments
 (0)