nanakura/moeka-project
1
0
Fork 0
Code Issues Pull Requests 1 Actions 2 Packages Projects Releases Wiki Activity

docs(CONTRIBUTING): update naming and command

Browse Source 
Co-authored-by: LiliumNeko <30291104+liliumneko@users.noreply.github.com>
This commit is contained in:
Neko Ayaka
2025-06-30 17:40:29 +08:00
co-authored by LiliumNeko
parent bb59f327b0
commit 6c2801eb05
2 changed files with 65 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/CONTRIBUTING.md
+31 -31
View File
@@ -1,4 +1,4 @@
# Start contributing to [airi](https://github.com/moeru-ai/airi)
# Start contributing to [Project AIRI](https://github.com/moeru-ai/airi)
Hello! Thank you for your interest in contributing to this project. This guide will help you get started.
@@ -149,10 +149,38 @@ cargo fetch
## Choose the application you want to develop on
### Stage Tamagotchi (Desktop version)
```shell
pnpm dev:tamagotchi
```
> [!NOTE]
>
> For [@antfu/ni](https://github.com/antfu-collective/ni) users, you can
>
> ```shell
> nr dev:tamagotchi
> ```
### Stage Web (Browser version for [airi.moeru.ai](https://airi.moeru.ai))
```shell
pnpm dev
```
> [!NOTE]
>
> For [@antfu/ni](https://github.com/antfu-collective/ni) users, you can
>
> ```shell
> nr dev
> ```
### Documentation site
```shell
pnpm -F @proj-airi/docs dev
pnpm dev:docs
```
> [!NOTE]
@@ -160,35 +188,7 @@ pnpm -F @proj-airi/docs dev
> For [@antfu/ni](https://github.com/antfu-collective/ni) users, you can
>
> ```shell
> nr -F @proj-airi/docs dev
> ```
### Stage web (Frontend for [airi.moeru.ai](https://airi.moeru.ai), or [airi.ayaka.io](https://airi.ayaka.io))
```shell
pnpm -F @proj-airi/stage-web dev
```
> [!NOTE]
>
> For [@antfu/ni](https://github.com/antfu-collective/ni) users, you can
>
> ```shell
> nr -F @proj-airi/stage-web dev
> ```
### Stage Tamagotchi (Electron app for アイリ VTuber)
```shell
pnpm -F @proj-airi/stage-tamagotchi dev
```
> [!NOTE]
>
> For [@antfu/ni](https://github.com/antfu-collective/ni) users, you can
>
> ```shell
> nr -F @proj-airi/stage-tamagotchi dev
> nr dev:docs
> ```
### Telegram bot integration
docs/src/content/docs/references/Contributing/guide.md
+34 -34
View File
@@ -151,10 +151,42 @@ You don't need to care about the package manager, `ni` will help you choose the
## Choose the application you want to develop on
### Stage Tamagotchi (Desktop version)
```shell
pnpm dev:tamagotchi
```
:::note
For [@antfu/ni](https://github.com/antfu-collective/ni) users, you can
```shell
nr dev:tamagotchi
```
:::
### Stage Web (Browser version for [airi.moeru.ai](https://airi.moeru.ai))
```shell
pnpm dev
```
:::note
For [@antfu/ni](https://github.com/antfu-collective/ni) users, you can
```shell
nr dev
```
:::
### Documentation site
```shell
pnpm -F @proj-airi/docs dev
pnpm dev:docs
```
:::note
@@ -162,39 +194,7 @@ pnpm -F @proj-airi/docs dev
For [@antfu/ni](https://github.com/antfu-collective/ni) users, you can
```shell
nr -F @proj-airi/docs dev
```
:::
### Stage web (Frontend for [airi.moeru.ai](https://airi.moeru.ai), or [airi.ayaka.io](https://airi.ayaka.io))
```shell
pnpm -F @proj-airi/stage-web dev
```
:::note
For [@antfu/ni](https://github.com/antfu-collective/ni) users, you can
```shell
nr -F @proj-airi/stage-web dev
```
:::
### Stage Tamagotchi (Electron app for アイリ VTuber)
```shell
pnpm -F @proj-airi/stage-tamagotchi dev
```
:::note
For [@antfu/ni](https://github.com/antfu-collective/ni) users, you can
```shell
nr -F @proj-airi/stage-tamagotchi dev
nr dev:docs
```
:::