Skip to content

Commit 02796fa

Browse files
authored
docs: beautify README (#13)
1 parent 0a50448 commit 02796fa

File tree

1 file changed

+41
-36
lines changed

1 file changed

+41
-36
lines changed

README.md

Lines changed: 41 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,66 @@
11
# Agent Skills
22

3-
A collection of Agent Skills for [Rstack](https://rspack.rs/guide/start/ecosystem#rstack).
3+
<p>
4+
<a href="https://discord.gg/XsaKEEk4mW"><img src="https://img.shields.io/badge/chat-discord-blue?style=flat-square&logo=discord&colorA=564341&colorB=EDED91" alt="discord channel" /></a>
5+
<a href="https://github.com/rstackjs/agent-skills/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" /></a>
6+
<a href="https://github.com/rstackjs/agent-skills"><img src="https://img.shields.io/github/stars/rstackjs/agent-skills?style=flat-square&colorA=564341&colorB=EDED91" alt="stars" /></a>
7+
<a href="https://github.com/rstackjs/agent-skills/issues"><img src="https://img.shields.io/github/issues/rstackjs/agent-skills?style=flat-square&colorA=564341&colorB=EDED91" alt="issues" /></a>
8+
</p>
49

5-
## Rspack Skills
10+
A collection of Agent Skills for [Rstack](https://rspack.rs/guide/start/ecosystem#rstack).
611

7-
### rspack-debugging
12+
> AI-powered skills for debugging, tracing, upgrading, and analyzing Rstack projects.
813
9-
```bash
10-
npx skills add rstackjs/agent-skills --skill rspack-debugging
11-
```
14+
## Table of Contents
1215

13-
Helps Rspack users and developers debug crashes or deadlocks/hangs in the Rspack build process using LLDB.
16+
- [Usage](#usage)
17+
- [Skills](#skills)
18+
- [Rspack](#rspack)
19+
- [Rsbuild](#rsbuild)
20+
- [Rspress](#rspress)
21+
- [Rsdoctor](#rsdoctor)
22+
- [Contributing](#contributing)
23+
- [License](#license)
1424

15-
Use this Skill when users encounter "Segmentation fault" errors during Rspack builds or when the build progress gets stuck.
25+
## Usage
1626

17-
### rspack-tracing
27+
Install any skill with:
1828

1929
```bash
20-
npx skills add rstackjs/agent-skills --skill rspack-tracing
30+
npx skills add rstackjs/agent-skills --skill <skill-name>
2131
```
2232

23-
Comprehensive guide and toolkit for diagnosing Rspack build issues. Quickly identify where crashes/errors occur, or perform detailed performance profiling to resolve bottlenecks.
24-
25-
Use when the user encounters build failures, slow builds, or wants to optimize Rspack performance.
26-
27-
## Rsbuild Skills
28-
29-
### rsbuild-v2-upgrade
33+
## Skills
3034

31-
```bash
32-
npx skills add rstackjs/agent-skills --skill rsbuild-v2-upgrade
33-
```
35+
### Rspack
3436

35-
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.
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 |
3641

37-
## Rspress Skills
42+
### Rsbuild
3843

39-
### rspress-v2-upgrade
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 |
4047

41-
```bash
42-
npx skills add rstackjs/agent-skills --skill rspress-v2-upgrade
43-
```
48+
### Rspress
4449

45-
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.
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 |
4653

47-
## Rsdoctor Skills
54+
### Rsdoctor
4855

49-
### rsdoctor-analysis
50-
51-
```bash
52-
npx skills add rstackjs/agent-skills --skill rsdoctor-analysis
53-
```
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 |
5459

55-
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.
60+
## Contributing
5661

57-
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.
62+
Contributions are welcome! Feel free to open an [issue](https://github.com/rstackjs/agent-skills/issues) or submit a [pull request](https://github.com/rstackjs/agent-skills/pulls).
5863

5964
## License
6065

61-
MIT licensed.
66+
[MIT](./LICENSE)

0 commit comments

Comments
 (0)