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.

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

コマンドに関するドキュメントを追加 #54

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions docs/commands/auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# auth
## Syntax
```
/auth
```

## Feature
- コマンドを実行したユーザーを認証します。
- FirestoreにユーザーのdiscordIDと紐づくデータMemberが存在する場合に、認証が成功します。
- 認証に成功したユーザーは、`Authorized`ロールを得ます。

## Important
メール認証が完了していない場合、データがFirestoreに存在しても認証に失敗します。

12 changes: 12 additions & 0 deletions docs/commands/health_check.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# health_check
## Syntax
```
/health_check
```

## Feature
- ボットの生存確認を行います。
- ボットが生存している場合は、`I am healthy!`を返します。

## Important
特にありません
13 changes: 13 additions & 0 deletions docs/commands/register.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# register
## Syntax
```
/register [mail] [name] [department] [student_number]
```

## Feature
- 引数の情報に従い、Firestoreにユーザ情報を登録します
- 引数が足りない場合、コマンドは実行されません

## Important
- registerコマンドはユーザー情報を登録するにとどまります。
- 登録したユーザーがサーバーを利用するためには、メール認証の後、`/auth`コマンドを実行する必要があります。
14 changes: 14 additions & 0 deletions docs/commands/rename_all.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# rename_all
## Syntax
```
/rename_all
```

## Feature
- サーバー内の全ユーザーの表示名を本名に変更します
- 本名はFirestoreから参照されます

## Important
- Botよりも権限の高い、または同等のユーザーの表示名は変更することができません
- 例えば、サーバー管理者の表示名は変更することができません。
- Firestoreに情報が登録されていないユーザーの表示名も変更することができません
12 changes: 12 additions & 0 deletions docs/commands/who.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# who
## Syntax
```
/who [User]
```

## Feature
- 指定されたユーザーの情報を表示します
- ユーザー情報はFirestoreから参照されます

## Important
特にありません