docs: Add DataLoader section to resource link documentation #327
Conversation
Walkthroughresource_link.mdガイドにDataLoaderの説明と使用例を追加。クエリのバッチ処理（N+1回避）に関する概念、図解、 Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In @manuals/1.0/en/resource_link.md:
- Around line 215-220: The fenced code block containing the ASCII diagram (the
triple-backtick block wrapping "Author (1 query) └── Post × 3 ...") lacks a
language identifier; update the opening fence to include a language such as
"text" or "plaintext" (i.e., change the opening ``` to ```text) so the Markdown
linter warning is resolved while leaving the diagram content unchanged.
- Around line 223-227: The fenced code block in the snippet showing the ASCII
tree lacks a language identifier; update the block in
manuals/1.0/en/resource_link.md so the opening fence is ```text (or another
appropriate tag) instead of just ```, ensuring the closing fence remains ```, to
satisfy the Markdown linter.
📜 Review details
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
manuals/1.0/en/resource_link.md
🧰 Additional context used
📓 Path-based instructions (1)
manuals/1.0/{en,ja}/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
All documentation markdown files should be placed in 'manuals/1.0/{en,ja}/' directories.
Files:
manuals/1.0/en/resource_link.md
🪛 markdownlint-cli2 (0.18.1)
manuals/1.0/en/resource_link.md
215-215: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
223-223: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (1)
manuals/1.0/en/resource_link.md (1)
207-305: DataLoaderセクションは包括的で構造が良好です。新しいセクションは、N+1問題の説明から実装例、キー推論まで、分かりやすく段階的に説明されています。PHP実装例（行233-265と行295-305）は正しく言語識別子が指定されており、コード品質も高いです。
| ``` | ||
| Author (1 query) | ||
| └── Post × 3 (1 query, returns 3) | ||
| └── Meta (3 queries) ← N+1 problem! | ||
| ``` | ||
|
|
There was a problem hiding this comment.
フェンスコードブロックに言語識別子を指定してください。
マークダウンリンタの警告に従い、コードブロックに言語を指定する必要があります。このテキスト図には text または plaintext を使用してください。
修正案
-```
+```text
Author (1 query)
└── Post × 3 (1 query, returns 3)
└── Meta (3 queries) ← N+1 problem!
-```
+```🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
215-215: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In @manuals/1.0/en/resource_link.md around lines 215 - 220, The fenced code
block containing the ASCII diagram (the triple-backtick block wrapping "Author
(1 query) └── Post × 3 ...") lacks a language identifier; update the opening
fence to include a language such as "text" or "plaintext" (i.e., change the
opening ``` to ```text) so the Markdown linter warning is resolved while leaving
the diagram content unchanged.
| ``` | ||
| Author (1 query) | ||
| └── Post × 3 (1 query) | ||
| └── Meta (1 batched query) ← Solved! | ||
| ``` |
There was a problem hiding this comment.
フェンスコードブロックに言語識別子を指定してください。
マークダウンリンタの警告に従い、このテキスト図にも言語識別子を追加してください。
修正案
-```
+```text
Author (1 query)
└── Post × 3 (1 query)
└── Meta (1 batched query) ← Solved!
-```
+```🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
223-223: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In @manuals/1.0/en/resource_link.md around lines 223 - 227, The fenced code
block in the snippet showing the ASCII tree lacks a language identifier; update
the block in manuals/1.0/en/resource_link.md so the opening fence is ```text (or
another appropriate tag) instead of just ```, ensuring the closing fence remains
```, to satisfy the Markdown linter.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @manuals/1.0/ja/resource_link.md:
- Around line 206-210: Add a language specifier "text" to the fenced code blocks
that contain the ASCII-art diagrams so they comply with Markdownlint; locate the
blocks that start with the diagram lines "Author (1クエリ)" and change the opening
fence from ``` to ```text for both occurrences (the block around the diagram
showing "Meta (3クエリ) ← N+1問題！" and the block showing "Meta (1バッチクエリ) ← 解決！"),
leaving the closing fences as ``` unchanged.
📜 Review details
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
manuals/1.0/ja/resource_link.md
🧰 Additional context used
📓 Path-based instructions (1)
manuals/1.0/{en,ja}/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
All documentation markdown files should be placed in 'manuals/1.0/{en,ja}/' directories.
Files:
manuals/1.0/ja/resource_link.md
🪛 markdownlint-cli2 (0.18.1)
manuals/1.0/ja/resource_link.md
206-206: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
214-214: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (1)
manuals/1.0/ja/resource_link.md (1)
197-296: DataLoaderドキュメンテーションは包括的で構成が適切です。DataLoaderセクション全体を確認しました。以下の点が優れています:
- N+1問題の明確な説明とビジュアル化
- 実装例が実用的で、Aura.SqlとRay.MediaQueryの両方のパターンを提示
- URIテンプレートからのキー推論の明確な表説明
- 複数キーの処理例が具体的
構成と内容は指針に準拠しており、読者にとって実装が容易です。
| ``` | ||
| Author (1クエリ) | ||
| └── Post × 3 (1クエリ、3件返却) | ||
| └── Meta (3クエリ) ← N+1問題！ | ||
| ``` |
There was a problem hiding this comment.
コードブロックの言語指定を追加してください。
Markdownlintの規則に従い、フェンスされたコードブロックには言語指定が必要です。ASCIIアートダイアグラムの場合はtextを指定してください。
📝 推奨される修正
-```
+```text
Author (1クエリ)
└── Post × 3 (1クエリ、3件返却)
└── Meta (3クエリ) ← N+1問題！
-```
+```同様に214行目も修正してください:
-```
+```text
Author (1クエリ)
└── Post × 3 (1クエリ)
└── Meta (1バッチクエリ) ← 解決！
-```
+```Also applies to: 214-218
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
206-206: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In @manuals/1.0/ja/resource_link.md around lines 206 - 210, Add a language
specifier "text" to the fenced code blocks that contain the ASCII-art diagrams
so they comply with Markdownlint; locate the blocks that start with the diagram
lines "Author (1クエリ)" and change the opening fence from ``` to ```text for both
occurrences (the block around the diagram showing "Meta (3クエリ) ← N+1問題！" and the
block showing "Meta (1バッチクエリ) ← 解決！"), leaving the closing fences as ```
unchanged.
Summary
Add documentation for the new DataLoader feature that solves N+1 problems in Crawl operations.
Related PR: bearsunday/BEAR.Resource#346
Content Added (EN & JA)
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.