docs:README.mdの修正 #83
Conversation
Walkthrough大規模な新機能やエンドポイントの導入はなく、 Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (1)
README.md (1)
Line range hint
475-475: 公式のNext.jsドキュメントを参照してください。利用可能なオプションは、Next.jsのタイプファイルに依存します。ここにカンマが不足している可能性があります。- 公式のNext.jsドキュメントを参照してください。利用可能なオプションは、Next.jsのタイプファイルに依存します。 + 公式のNext.jsドキュメントを参照してください。利用可能なオプションは、Next.jsのタイプファイルに依存します。
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (18 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~475-~475: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...t. Please refer to the official Next.js documentation as the available options depend on the ...
Additional comments not posted (3)
README.md (3)
8-8: 見出しの表記が統一されており、リンクも正しく設定されています。この変更はドキュメントの利便性を向上させるものです。
49-54: ES6のインポート構文を追加したことで、モダンなJavaScriptプロジェクトに対応しやすくなりました。ただし、CommonJSとES6の両方の例を示すことで、異なる環境での使用方法を明確にしています。
108-118:getListメソッドに多くのクエリパラメータを追加することで、APIの柔軟性が向上しています。ただし、これらのパラメータがすべてのユーザーにとって明確であるかどうか、ドキュメントでさらに詳細な説明が必要かもしれません。#!/bin/bash # Description: Verify the clarity and completeness of the documentation for the new query parameters in getList method. # Test: Search for additional documentation on the new query parameters. Expect: Detailed descriptions for each parameter. rg --type markdown $'getList'
There was a problem hiding this comment.
@wasabi-tr
整理ありがとうございます！ご確認お願いします！
-
get, getList, getListDetail, getObjectの使い分けの方法が記されていると良いかも?
-
「with ○○」など、活用のユースケースを書く項目については、利用しているメソッドは変わらないので、上位のセクションから、一段ネストされていると見やすいですかね？
-
「Management API」のセクションを残す場合は、「Contents API」のセクションを最初に作った方が良いでしょうか？
-
「UploadMedia API」の項目だけ、少し特殊な書き方になっている気がします。
他の項目では、裏側で利用されているエンドポイントは明記されていないですが、ここだけ書かれているためです。
他に合わせるなら、「Upload media」でしょうか？ -
表記揺れの統一ができると良さそうです
- UsageとUsing
- TypeScriptとType Definition
There was a problem hiding this comment.
Actionable comments posted: 5
Outside diff range and nitpick comments (2)
README.md (2)
54-66: CommonJSとES6のインポートステートメントが両方提供されていますが、文書全体の一貫性を保つために、どちらか一方に統一することを検討してください。
Line range hint
492-492: 文中にカンマが不足している可能性があります。文の流れを改善するために、適切な場所にカンマを追加することを検討してください。- Please refer to the official Next.js documentation as the available options depend on the Next.js Type file. + Please refer to the official Next.js documentation, as the available options depend on the Next.js Type file.Tools
Markdownlint
7-7: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (21 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~492-~492: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...t. Please refer to the official Next.js documentation as the available options depend on the ...
Markdownlint
README.md
7-7: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
660-660: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document
76-76: Punctuation: '.' (MD026, no-trailing-punctuation)
Trailing punctuation in heading
550-550: Punctuation: '.' (MD026, no-trailing-punctuation)
Trailing punctuation in heading
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range and nitpick comments (1)
README.md (1)
Line range hint
492-492: Next.jsのドキュメントに関する説明にカンマが不足しています。文の流れを改善するためにカンマを追加することをお勧めします。- Please refer to the official Next.js documentation as the available options depend on the Next.js Type file. + Please refer to the official Next.js documentation, as the available options depend on the Next.js Type file.Tools
Markdownlint
7-7: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (21 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~163-~163: “form” (shape/structure, to make) seems less likely than “from” (“originating from”). (AI_HYDRA_LEO_CP_FORM_FROM)
Context: ...hod is used to retrieve a single object form content ```javascript client .getObj...
[uncategorized] ~492-~492: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...t. Please refer to the official Next.js documentation as the available options depend on the ...
Markdownlint
README.md
7-7: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
660-660: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document
76-76: Punctuation: '.' (MD026, no-trailing-punctuation)
Trailing punctuation in heading
550-550: Punctuation: '.' (MD026, no-trailing-punctuation)
Trailing punctuation in heading
Additional comments not posted (4)
README.md (4)
7-9: 見出しの前後に空行が必要です。Markdownの規則に従って、見出しの前後には空行を入れることが推奨されています。Tools
Markdownlint
7-7: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
76-76: 見出しの末尾に不要な句点があります。Markdownのスタイルガイドに従って、見出しの末尾には句点を付けないようにしてください。Tools
Markdownlint
76-76: Punctuation: '.' (MD026, no-trailing-punctuation)
Trailing punctuation in heading
107-121:getListメソッドに多くのパラメータが追加されています。これにより、メソッドの使いやすさが向上していますが、各パラメータの説明を追加することで、さらにユーザーフレンドリーになるでしょう。
550-550: 見出しの末尾に不要な句点があります。Markdownのスタイルガイドに従って、見出しの末尾には句点を付けないようにしてください。Tools
Markdownlint
550-550: Punctuation: '.' (MD026, no-trailing-punctuation)
Trailing punctuation in heading
There was a problem hiding this comment.
Actionable comments posted: 4
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (21 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~493-~493: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...t. Please refer to the official Next.js documentation as the available options depend on the ...
Markdownlint
README.md
661-661: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document
77-77: Punctuation: '.' (MD026, no-trailing-punctuation)
Trailing punctuation in heading
551-551: Punctuation: '.' (MD026, no-trailing-punctuation)
Trailing punctuation in heading
Additional comments not posted (2)
README.md (2)
55-65: CommonJSとES6のインポートステートメントが両方示されていますが、プロジェクトの一貫性を保つためにどちらか一つに統一することをお勧めします。- const { createClient } = require('microcms-js-sdk'); // CommonJS - - or - - import { createClient } from 'microcms-js-sdk'; //ES6 + import { createClient } from 'microcms-js-sdk'; //ES6Likely invalid or redundant comment.
164-164: メソッド名に誤字があります。「form」ではなく「from」が正しい表現です。- The `getObject` method is used to retrieve a single object form content + The `getObject` method is used to retrieve a single object from contentLikely invalid or redundant comment.
|
修正しましたので、ご確認お願いします！ 修正内容
追加修正
|
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (2)
README.md (2)
Line range hint
493-493: 公式のNext.jsのドキュメントを参照してください。利用可能なオプションは、Next.jsのTypeファイルに依存します。ここにコンマが必要です。- Please refer to the official Next.js documentation as the available options depend on the ... + Please refer to the official Next.js documentation, as the available options depend on the ...
Line range hint
661-661: ドキュメント内に複数のトップレベルの見出しが存在します。Markdownの規則に従って、一つのドキュメントに一つのトップレベルの見出しのみを使用することが推奨されています。- # microCMS JavaScript SDK + ## microCMS JavaScript SDK
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (21 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~164-~164: “form” (shape/structure, to make) seems less likely than “from” (“originating from”). (AI_HYDRA_LEO_CP_FORM_FROM)
Context: ...hod is used to retrieve a single object form content ```javascript client .getObj...
[uncategorized] ~493-~493: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...t. Please refer to the official Next.js documentation as the available options depend on the ...
Markdownlint
README.md
661-661: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document
Additional comments not posted (3)
README.md (3)
7-10: 見出しの前後に空行が必要です。Markdownの規則に従って、見出しの前後には空行を入れることが推奨されています。
93-102:getListのメソッド使用例において、エラーハンドリングの実装が不十分です。エラーが発生した場合にユーザーに適切なフィードバックを提供するために、エラーメッセージを改善することをお勧めします。
164-164: メソッド名に誤字があります。「form」ではなく「from」が正しい表現です。Tools
LanguageTool
[uncategorized] ~164-~164: “form” (shape/structure, to make) seems less likely than “from” (“originating from”). (AI_HYDRA_LEO_CP_FORM_FROM)
Context: ...hod is used to retrieve a single object form content ```javascript client .getObj...
There was a problem hiding this comment.
Actionable comments posted: 6
Outside diff range and nitpick comments (1)
README.md (1)
Line range hint
362-377:updateメソッドの説明には、単一のコンテンツを更新する方法が示されていますが、エラーハンドリングが不足しています。エラー処理を追加することをお勧めします。+ .catch((err) => console.error("コンテンツの更新中にエラーが発生しました: ", err));
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (19 hunks)
Additional context used
Markdownlint
README.md
136-136: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
683-683: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document
115-115: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
Additional comments not posted (1)
README.md (1)
7-10: 見出しの前後に空行を追加することをお勧めします。これにより、Markdownの可読性が向上します。+ +Likely invalid or redundant comment.
There was a problem hiding this comment.
Actionable comments posted: 6
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (19 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~518-~518: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...t. Please refer to the official Next.js documentation as the available options depend on the ...
Markdownlint
README.md
136-136: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
683-683: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document
115-115: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
Additional comments not posted (1)
README.md (1)
13-13: Node.jsのバージョン要件を明記していますが、これはユーザーにとって非常に有益です。この変更を承認します。
|
修正しましたので、再度ご確認お願いします！
|
README.md
Outdated
| @@ -295,25 +397,30 @@ client | |||
|
|
|||
| If you are using TypeScript, use `getList`, `getListDetail`, `getObject`. This internally contains a common type of content. | |||
|
|
|||
| #### Response Type for getList Method | |||
There was a problem hiding this comment.
ここを含む数箇所なんですが、タイトルケースでの表記になっているかも？
センテンスケースでの表記が大半かとおもったので、そちらに統一した方が違和感はないかなとは思いました！
There was a problem hiding this comment.
Actionable comments posted: 8
Outside diff range and nitpick comments (1)
README.md (1)
Line range hint
275-288:createメソッドの説明には、コンテンツを登録する方法が示されていますが、エラーハンドリングが不足しています。エラー処理を追加することをお勧めします。client .create({ endpoint: 'endpoint', content: { title: 'title', body: 'body', }, }) .then((res) => console.log(res.id)) - .catch((err) => console.error(err)); + .catch((err) => console.error("コンテンツの登録中にエラーが発生しました: ", err));
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (20 hunks)
Additional context used
Markdownlint
README.md
668-668: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document
104-104: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
Additional comments not posted (1)
README.md (1)
109-109: リスト形式のAPIに対してのみ利用できて、オブジェクト形式のAPIでは利用できないことを明記しても良いですかね？（他も同様です）
There was a problem hiding this comment.
Actionable comments posted: 6
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (20 hunks)
Additional context used
Markdownlint
README.md
668-668: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document
104-104: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
|
細かい点までご確認いただきありがとうございます🙇♂️ 修正内容
|
修正内容
Summary by CodeRabbit
microcms-js-sdkライブラリの使用方法とAPIメソッドに関する変更を追加しました。これには、インストール手順、使用例、および各種APIメソッドのレスポンスタイプ定義が含まれます。clientオブジェクトのgetListメソッドにクエリパラメータのサポートを追加しました。