Feature/0001 - #8
Conversation
🔗 関連するNotionタスク状態: 進行中 |
Summary of ChangesHello @Koonosuke, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! このプルリクエストは、主にプロジェクトのファイル構造を整理し、ドキュメントの視認性と互換性を向上させることを目的としています。具体的には、AWS関連ファイルのディレクトリを再編成し、Mermaid図の表示をGitHub環境に最適化しました。また、IoT CoreとのインタラクションをテストするためのPostmanリクエストのサンプルを追加し、開発者が容易に機能を検証できるようにしました。 Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
| end note | ||
| %% メモ代替(GitHubのMermaid対応版) | ||
| apigw <-.- apigw_note(["電源をONにせよ"]) | ||
| shadow -.-> shadow_note["差分を管理 desired: Power: ON reported: Power: OFF delta: Power: ON"] |
There was a problem hiding this comment.
Mermaidのノートの可読性向上のための提案です。
現在、shadow_note のテキストが一行に長く連なっており、少し読みにくくなっています。
Mermaidのラベル内では <br> タグを使って改行を挿入できます。これを利用して、以前の note 構文のように複数行で表示させると、より可読性が高まるかと思います。
| shadow -.-> shadow_note["差分を管理 desired: Power: ON reported: Power: OFF delta: Power: ON"] | |
| shadow -.-> shadow_note["差分を管理<br>desired: Power: ON<br>reported: Power: OFF<br>delta: Power: ON"] |
| ``` | ||
| // { | ||
| // "deviceId": "xiao-22fi041", | ||
| // "type": "echo", | ||
| // "payload": { | ||
| // "message": "Hello from B3!" | ||
| // } | ||
| // } | ||
|
|
||
| //{ | ||
| // "deviceId": "xiao-22fi041", | ||
| // "type": "led", | ||
| // "payload": { | ||
| // "pattern": "on" | ||
| // } | ||
| // } | ||
|
|
||
| // { | ||
| // "deviceId": "xiao-22fi041", | ||
| // "type": "led", | ||
| // "payload": { | ||
| // "pattern": "blink" | ||
| // } | ||
| // } | ||
|
|
||
| // { | ||
| // "deviceId": "xiao-22fi041", | ||
| // "type": "servo", | ||
| // "payload": { | ||
| // "direction": "left", | ||
| // "degree": 90 | ||
| // } | ||
| // } | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Postmanのリクエスト例の記述方法について提案です。
現在、すべてのリクエスト例が単一のコードブロック内で // を使ってコメントアウトされています。これでは、利用者がコピー&ペーストして使う際に、手動でコメントを外す手間がかかってしまいます。
各リクエスト例を個別の json コードブロックとして記述し、Markdownの見出しで説明を加える形式にすると、可読性と再利用性が大幅に向上します。
例えば、以下のような形式が考えられます。
### Echoリクエスト
```json
{
"deviceId": "xiao-22fi041",
"type": "echo",
"payload": {
"message": "Hello from B3!"
}
}
```
### LED点灯リクエスト
```json
{
"deviceId": "xiao-22fi041",
"type": "led",
"payload": {
"pattern": "on"
}
}
```### Echoリクエスト
```json
{
"deviceId": "xiao-22fi041",
"type": "echo",
"payload": {
"message": "Hello from B3!"
}
}LED点灯リクエスト
{
"deviceId": "xiao-22fi041",
"type": "led",
"payload": {
"pattern": "on"
}
}LED点滅リクエスト
{
"deviceId": "xiao-22fi041",
"type": "led",
"payload": {
"pattern": "blink"
}
}サーボモーター制御リクエスト
{
"deviceId": "xiao-22fi041",
"type": "servo",
"payload": {
"direction": "left",
"degree": 90
}
}
概要
その他