docs(readme): clarify prefetch via client bundle#465
Conversation
|
No actionable comments were generated in the recent review. 🎉 📝 WalkthroughWalkthroughTwo new README.md sections were added under Client Bundle configuration: "Disabling Runtime Fetching" (showing Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README.md (2)
487-502: Redundantprovider: 'none'example — already documented at lines 231–243.Lines 231–243 already show this exact pattern:
icon: { provider: 'none', clientBundle: { scan: true, /* ...or other bundle options */ } }The new block at lines 489–502 repeats the same guidance. Consider replacing it with a brief cross-reference (e.g.,
> See also [Custom Local Collections](#custom-local-collections) for the \provider: 'none'` pattern.`) or consolidating the examples.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 487 - 502, Remove the duplicated example that sets provider: 'none' with a clientBundle block and instead replace that block with a brief cross-reference to the existing "Custom Local Collections" section (which already shows icon: { provider: 'none', clientBundle: {...} }); update the new example location to a single line like "> See also [Custom Local Collections](`#custom-local-collections`) for the provider: 'none' + clientBundle pattern" so the README only documents provider: 'none' once while preserving discoverability of clientBundle usage.
504-507: TIP duplicates the existing tip under "Scan Components" (lines 559–570).The "Scan Components" subsection already contains a
[!TIP]with the same message and a concrete Vue template example illustrating literal vs. dynamic name patterns. The new tip (lines 504–507) repeats only the prose without the example, offering less context. Consider removing the new tip and pointing readers to the existing, richer one:-> [!TIP] -> Static scanning relies on literal values. Dynamically generated icon names are not reliably detected, so add them explicitly in `clientBundle.icons`. -> This is also useful for component-test setups documented in [Rendering Icons in Component Tests](`#rendering-icons-in-component-tests`). +> [!TIP] +> Static scanning only detects literal icon names. See [Scan Components](`#scan-components`) for details, and [Rendering Icons in Component Tests](`#rendering-icons-in-component-tests`) for test-environment setup.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 504 - 507, Remove the duplicated [!TIP] block at the earlier location (the one advising to add icon names to clientBundle.icons) and replace it with a short cross-reference to the existing "Scan Components" subsection that already contains the full tip and Vue template example; specifically, delete the redundant tip text and add a sentence linking readers to "Scan Components" for the richer guidance and example demonstrating literal vs dynamic icon name patterns (mentioning clientBundle.icons as the configuration key).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 449-507: The inserted "Prefetch (Preload) Icons" subsection left
the full clientBundle options block (the code example that shows icons, scan,
includeCustomCollections, sizeLimitKb) orphaned and visually nested; add a short
heading such as "#### Available Options" immediately before that full-options
code block to re-anchor it as the canonical reference under the broader Client
Bundle section so readers can clearly distinguish the prefetch examples from the
comprehensive configuration example.
---
Nitpick comments:
In `@README.md`:
- Around line 487-502: Remove the duplicated example that sets provider: 'none'
with a clientBundle block and instead replace that block with a brief
cross-reference to the existing "Custom Local Collections" section (which
already shows icon: { provider: 'none', clientBundle: {...} }); update the new
example location to a single line like "> See also [Custom Local
Collections](`#custom-local-collections`) for the provider: 'none' + clientBundle
pattern" so the README only documents provider: 'none' once while preserving
discoverability of clientBundle usage.
- Around line 504-507: Remove the duplicated [!TIP] block at the earlier
location (the one advising to add icon names to clientBundle.icons) and replace
it with a short cross-reference to the existing "Scan Components" subsection
that already contains the full tip and Vue template example; specifically,
delete the redundant tip text and add a sentence linking readers to "Scan
Components" for the richer guidance and example demonstrating literal vs dynamic
icon name patterns (mentioning clientBundle.icons as the configuration key).
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 487: Add a named HTML anchor immediately above the code block that shows
the provider: 'none' example (the specific snippet referenced in the README) and
update the existing cross-reference link text on line 487 to point to that new
anchor instead of `#custom-local-collections`; locate the provider: 'none' code
block in README.md, insert something like <a name="provider-none"></a> directly
above it, and change the link target from (`#custom-local-collections`) to
(`#provider-none`) so users land directly on the relevant example.
Fixes #99
Clarifies in
README.mdhow to prefetch icons withclientBundle:clientBundle.iconsclientBundle.scanprovider: 'none'for no runtime fetching