日本語版READMEの追加 #86
日本語版READMEの追加 #86
Conversation
ウォークスルーこの更新では、日本語版README.mdの追加、LICENSE情報の更新、microcms-js-sdkの機能拡張を実施しました。様々なメソッドに新しいオプションとパラメータを追加し、TypeScriptの型定義を改善しました。また、新たにManagement APIとメディアアップロードの対応を追加しました。 変更内容
ポエム
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: 3
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- README.md (2 hunks)
- README_jp.md (1 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~507-~507: 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
106-106: null (MD032, blanks-around-lists)
Lists should be surrounded by blank linesREADME_jp.md
9-9: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
35-35: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
108-108: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
Additional comments not posted (2)
README.md (2)
3-3: リンクの追加が正しく行われています。日本語版のREADMEへのリンクが適切に追加されており、アクセスが容易になりました。
670-670: 見出しレベルの変更が正しく行われています。「LICENSE」セクションの見出しレベルが適切に変更され、文書の構造が改善されました。
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README_jp.md (1 hunks)
Additional context used
Markdownlint
README_jp.md
106-106: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
Additional comments not posted (5)
README_jp.md (5)
106-106: リストの前後に空行を追加してください。Markdownの規約に従い、リストは空行で囲む必要があります。これにより、ドキュメントの可読性が向上します。
+ > - 「リスト形式」の✔️は、APIの型がリスト形式に設定されている場合に使用できるメソッドを示します。 > - 「オブジェクト形式」の✔️は、APIの型がオブジェクト形式に設定されている場合に使用できるメソッドを示します。 +Tools
Markdownlint
106-106: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
27-29: 重要なバージョン情報の強調バージョン情報が非常に重要なので、ユーザーが見逃さないように強調することをお勧めします。
> [!IMPORTANT] - > v3.0.0以上を使用する場合は、Node.jsのv18以上が必要です。 + > **v3.0.0以上を使用する場合は、Node.jsのv18以上が必要です。**
52-54: セキュリティに関する警告の改善ユーザーがセキュリティリスクをより明確に理解できるように、警告文をもう少し詳細に記述することをお勧めします。
> [!WARNING] - > ホスティングサービス（cdn.jsdelivr.net）はmicroCMSとは関係ありません。本番環境でのご利用には、お客様のサーバーでのセルフホスティングをお勧めします。 + > **警告:** ホスティングサービス（cdn.jsdelivr.net）はmicroCMSとは関係ありません。セキュリティとパフォーマンスを確保するために、本番環境ではお客様のサーバーでのセルフホスティングを強くお勧めします。
106-108: リストの周りの空行の追加Markdownのリストは前後に空行を入れることで、視覚的に区切りがつけられ、読みやすくなります。
+ > - 「リスト形式」の✔️は、APIの型がリスト形式に設定されている場合に使用できるメソッドを示します。 > - 「オブジェクト形式」の✔️は、APIの型がオブジェクト形式に設定されている場合に使用できるメソッドを示します。 +Tools
Markdownlint
106-106: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
397-401: TypeScriptの型定義の改善TypeScriptの型定義をもう少し詳しく説明することで、ユーザーがより理解しやすくなります。
#### getListメソッドのレスポンスの型 ```typescript type Content = { text: string, }; /** * { + * // `Content`型の配列を含むオブジェクトを返します。 * contents: Content[]; // 設定したスキーマの型を格納する配列 * totalCount: number; * limit: number; * offset: number; * } */ client.getList<Content>({ /* その他のプロパティ */ })</blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README_jp.md (1 hunks)
Additional context used
Markdownlint
README_jp.md
106-106: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
Additional comments not posted (9)
README_jp.md (9)
17-25: インストール手順の確認Node.jsのインストール手順が明確であり、npmとyarnの両方のオプションが提供されています。これはユーザーに選択肢を与える良いアプローチです。
32-36: ブラウザ用セルフホスティングの手順の明確化ダウンロードと使用方法についての説明が明確で、ユーザーが追従しやすい形になっています。ただし、具体的なサーバー設定に関する追加情報があればさらに親切かもしれません。
39-50: CDNを通じたブラウザでの利用方法の確認CDNを使用したスクリプトの読み込み方法が2つ提示されており、選択肢が提供されています。これにより、ユーザーが最新バージョンか特定バージョンを選べるようになっています。
52-54: セキュリティ警告の追加CDNの使用に関する警告が適切に記載されており、本番環境でのセルフホスティングの推奨が含まれています。これはセキュリティ意識の高い開発者にとって重要な情報です。
82-87: クライアントオブジェクトの作成方法の確認
createClient関数の使用方法が示されており、必要なパラメータが明確にリストアップされています。コメントアウトされたretryオプションも示されており、オプションの使用方法を理解する手助けになります。
91-104: APIメソッドの表の確認APIメソッドがリスト形式とオブジェクト形式でどのように使用できるかが表で示されています。この表は非常に有用で、ユーザーが各メソッドの適用可能なAPIタイプを簡単に理解できるようにしています。
404-415: TypeScriptの型定義の確認
getListメソッドのレスポンスの型がTypeScriptで適切に定義されています。これにより、型安全性が保証され、開発者がAPIから期待するデータ構造を正確に理解できます。
421-434: TypeScriptの型定義の確認
getListDetailメソッドのレスポンスの型がTypeScriptで適切に定義されています。これは、特定のコンテンツの詳細を取得する際に役立つ型情報を提供します。
440-452: TypeScriptの型定義の確認
getObjectメソッドのレスポンスの型がTypeScriptで適切に定義されています。これは、オブジェクト形式のコンテンツを取得する際に役立つ型情報を提供します。
作業内容
Summary by CodeRabbit
新機能
ドキュメント
機能強化