docs: update RSS wizard guides for recipe ID auto-generation (#8cb82c2)#554
docs: update RSS wizard guides for recipe ID auto-generation (#8cb82c2)#554
Conversation
- Updated Step 4 in HTML, Curl, and Search to RSS guides (EN/ZH) to document the new auto-generation behavior and refresh button for Recipe IDs. - Based on commit 8cb82c2. Co-authored-by: Colin-XKL <49122401+Colin-XKL@users.noreply.github.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates English and Chinese advanced RSS wizard guides (HTML to RSS, cURL to RSS, Search to RSS) so Step 4 accurately documents the new behavior where Recipe IDs are auto-pre-filled from the feed title and can be regenerated via a Refresh icon. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Summary of ChangesHello @Colin-XKL, 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! This pull request synchronizes the documentation for the RSS wizard guides with recent UI changes. It clarifies how Recipe IDs are now automatically pre-filled from the feed title and introduces the option to regenerate them using a new refresh button, ensuring users have accurate and up-to-date instructions. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
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
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
ⓘ You are approaching your monthly quota for Qodo. Upgrade your plan PR Compliance Guide 🔍Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label |
|||||||||||||||||||||||
ⓘ You are approaching your monthly quota for Qodo. Upgrade your plan PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates several documentation files to reflect the new auto-generation feature for Recipe IDs. The changes are generally good and clear. However, in the search-to-rss.md guides (both English and Chinese), an important detail about the Recipe ID being part of the feed's URL was removed. I've added comments with suggestions to restore this information for user clarity. The other file updates are correct.
| ### Step 4: Save Recipe | ||
|
|
||
| 1. **Recipe ID**: Choose a unique identifier for this recipe (e.g., `search-ai-news`). This will be part of your feed URL. | ||
| 1. **Recipe ID**: Choose a unique identifier for this recipe (e.g., `search-ai-news`). It is automatically pre-filled from the feed title, and you can click the **Refresh** icon to regenerate it. |
There was a problem hiding this comment.
The previous version of this line mentioned that the Recipe ID is part of the feed URL. This is important context for the user, especially since the 'Accessing Your Feed' section below shows the URL structure with {recipe-unique-id}. This information has been removed in the update. I suggest re-introducing it for clarity.
| 1. **Recipe ID**: Choose a unique identifier for this recipe (e.g., `search-ai-news`). It is automatically pre-filled from the feed title, and you can click the **Refresh** icon to regenerate it. | |
| 1. **Recipe ID**: Choose a unique identifier for this recipe (e.g., `search-ai-news`), which will be part of your feed URL. It is automatically pre-filled from the feed title, and you can click the **Refresh** icon to regenerate it. |
| ### 第四步：保存配方 (Save Recipe) | ||
|
|
||
| 1. **配方 ID (Recipe ID)**：为此配方选择一个唯一的标识符（例如 `search-ai-news`）。这将成为你订阅源 URL 的一部分。 | ||
| 1. **配方 ID (Recipe ID)**：为此配方选择一个唯一的标识符（例如 `search-ai-news`）。它会根据订阅源标题自动预填充，你也可以点击 **刷新** 图标重新生成。 |
There was a problem hiding this comment.
Similar to the English version of this file, the previous version of this line mentioned that the Recipe ID is part of the feed URL ('这将成为你订阅源 URL 的一部分'). This is important context for the user, especially since the '访问你的订阅源' section below shows the URL structure with {recipe-unique-id}. This information has been removed in the update. I suggest re-introducing it for clarity.
| 1. **配方 ID (Recipe ID)**：为此配方选择一个唯一的标识符（例如 `search-ai-news`）。它会根据订阅源标题自动预填充，你也可以点击 **刷新** 图标重新生成。 | |
| 1. **配方 ID (Recipe ID)**：为此配方选择一个唯一的标识符（例如 `search-ai-news`），它将成为你订阅源 URL 的一部分。它会根据订阅源标题自动预填充，你也可以点击 **刷新** 图标重新生成。 |
WalkthroughDocumentation updates clarify the Recipe Unique ID behavior across multiple advanced guide files in both English and Chinese. The changes specify that the Recipe ID is automatically pre-filled from the feed title and can be regenerated via a Refresh icon, replacing previous wording about auto-generation when left empty. Changes
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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 |
![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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
doc-site/src/content/docs/en/guides/advanced/html-to-rss.md (1)
60-66: 🛠️ Refactor suggestion | 🟠 MajorUse
<Steps>for the multi-step instructions.Step 4 enumerates multiple actions; per guidelines, multi-step instructions should use the
<Steps>component.
As per coding guidelines: “Use the<Steps>component for multi-step instructions (e.g., deployment or configuration) in Starlight documentation.”🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@doc-site/src/content/docs/en/guides/advanced/html-to-rss.md` around lines 60 - 66, The "Step 4: Save Recipe" section is a multi-action instruction and should be converted to use the <Steps> component; replace the plain heading and bullet list under "Step 4: Save Recipe" with a <Steps> block that contains each action as a step (e.g., generate a step for setting the Recipe Unique ID, a step for Internal Description, and any note about the Refresh icon), ensuring you preserve the existing text (including the example `tech-blog-feed` and the Refresh icon mention) inside individual <Steps> items so the documentation follows the Starlight guideline to "Use the <Steps> component for multi-step instructions."
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@doc-site/src/content/docs/en/guides/advanced/search-to-rss.md`:
- Around line 42-46: Update the zh-tw variant under the "### Step 4: Save
Recipe" section so the "Recipe ID" bullet matches the en/zh text: replace the
outdated sentence "這將成為你訂閱源 URL 的一部分" with the equivalent of
"它會自動從訂閱標題預填，您也可以點擊【刷新】圖示重新產生" (i.e., indicate automatic pre-fill from the feed
title and the Refresh icon to regenerate); keep the other bullets ("Internal
Description" and "Click Confirm & Save") unchanged and ensure the "Recipe ID"
label and example (e.g., search-ai-news) mirror the en/zh wording and
formatting.
In `@doc-site/src/content/docs/zh/guides/advanced/curl-to-rss.md`:
- Line 66: Replace the Chinese term "食谱" with the standardized term "配方" in the
sentence that currently reads "食谱唯一 ID (Recipe Unique ID)"; locate the string
"食谱唯一 ID (Recipe Unique ID)" in the curl-to-rss.md content and change it to
"配方唯一 ID (Recipe Unique ID)" so the documentation consistently uses "Recipe
(配方)" per guidelines.
In `@doc-site/src/content/docs/zh/guides/advanced/html-to-rss.md`:
- Line 64: Replace the Chinese term “食谱” with the standard term “配方” in the
sentence containing "食谱唯一 ID (Recipe Unique ID)"; update the text to read “配方唯一
ID (Recipe Unique ID)” and ensure any adjacent occurrences (e.g., the phrase
about auto-filling from the feed title and the “刷新” icon description) use “配方”
consistently to match the project's terminology for Recipe/配方.
---
Outside diff comments:
In `@doc-site/src/content/docs/en/guides/advanced/html-to-rss.md`:
- Around line 60-66: The "Step 4: Save Recipe" section is a multi-action
instruction and should be converted to use the <Steps> component; replace the
plain heading and bullet list under "Step 4: Save Recipe" with a <Steps> block
that contains each action as a step (e.g., generate a step for setting the
Recipe Unique ID, a step for Internal Description, and any note about the
Refresh icon), ensuring you preserve the existing text (including the example
`tech-blog-feed` and the Refresh icon mention) inside individual <Steps> items
so the documentation follows the Starlight guideline to "Use the <Steps>
component for multi-step instructions."
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
doc-site/src/content/docs/en/guides/advanced/curl-to-rss.mddoc-site/src/content/docs/en/guides/advanced/html-to-rss.mddoc-site/src/content/docs/en/guides/advanced/search-to-rss.mddoc-site/src/content/docs/zh/guides/advanced/curl-to-rss.mddoc-site/src/content/docs/zh/guides/advanced/html-to-rss.mddoc-site/src/content/docs/zh/guides/advanced/search-to-rss.md
| ### Step 4: Save Recipe | ||
|
|
||
| 1. **Recipe ID**: Choose a unique identifier for this recipe (e.g., `search-ai-news`). This will be part of your feed URL. | ||
| 1. **Recipe ID**: Choose a unique identifier for this recipe (e.g., `search-ai-news`). It is automatically pre-filled from the feed title, and you can click the **Refresh** icon to regenerate it. | ||
| 2. **Internal Description**: Notes for yourself about this recipe. | ||
| 3. Click **Confirm & Save**. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Find all language variants of search-to-rss.md
echo "=== Finding all language variants of search-to-rss.md ==="
fd -t f "search-to-rss.md" doc-site/src/content/docs/
echo -e "\n=== Checking en version (lines 40-48) ==="
sed -n '40,48p' doc-site/src/content/docs/en/guides/advanced/search-to-rss.md
echo -e "\n=== Checking zh-tw version (lines 40-48) ==="
if [ -f "doc-site/src/content/docs/zh-tw/guides/advanced/search-to-rss.md" ]; then
sed -n '40,48p' doc-site/src/content/docs/zh-tw/guides/advanced/search-to-rss.md
else
echo "File not found"
fi
echo -e "\n=== Checking zh version (lines 40-48) ==="
if [ -f "doc-site/src/content/docs/zh/guides/advanced/search-to-rss.md" ]; then
sed -n '40,48p' doc-site/src/content/docs/zh/guides/advanced/search-to-rss.md
else
echo "File not found"
fi
echo -e "\n=== Full file check - en version ==="
wc -l doc-site/src/content/docs/en/guides/advanced/search-to-rss.mdRepository: Colin-XKL/FeedCraft
Length of output: 1432
Fix zh-tw documentation to match en and zh versions.
The zh-tw variant at doc-site/src/content/docs/zh-tw/guides/advanced/search-to-rss.md (lines 42-46) contains outdated content that does not match the en and zh versions. The zh-tw version currently states "這將成為你訂閱源 URL 的一部分" (becomes part of feed URL), but the updated en version specifies "It is automatically pre-filled from the feed title, and you can click the Refresh icon to regenerate it." The zh version is correctly synced. Per documentation requirements, all language versions must be updated simultaneously.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@doc-site/src/content/docs/en/guides/advanced/search-to-rss.md` around lines
42 - 46, Update the zh-tw variant under the "### Step 4: Save Recipe" section so
the "Recipe ID" bullet matches the en/zh text: replace the outdated sentence
"這將成為你訂閱源 URL 的一部分" with the equivalent of "它會自動從訂閱標題預填，您也可以點擊【刷新】圖示重新產生" (i.e.,
indicate automatic pre-fill from the feed title and the Refresh icon to
regenerate); keep the other bullets ("Internal Description" and "Click Confirm &
Save") unchanged and ensure the "Recipe ID" label and example (e.g.,
search-ai-news) mirror the en/zh wording and formatting.
| 审查你的配置并将其保存为永久食谱。 | ||
|
|
||
| - **食谱唯一 ID (Recipe Unique ID)**：此订阅源配置的唯一标识符（例如 `my-custom-api-feed`）。如果留空，将自动根据订阅源标题生成。 | ||
| - **食谱唯一 ID (Recipe Unique ID)**：此订阅源配置的唯一标识符（例如 `my-custom-api-feed`）。它会根据订阅源标题自动预填充，你也可以点击 **刷新** 图标重新生成。 |
There was a problem hiding this comment.
统一术语为“配方”而非“食谱”。
此行使用“食谱”，与规范要求的 Recipe（配方）不一致，建议替换为“配方”。
As per coding guidelines: “Use 'AtomCraft' … and 'Recipe' (配方) consistently across all documentation.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@doc-site/src/content/docs/zh/guides/advanced/curl-to-rss.md` at line 66,
Replace the Chinese term "食谱" with the standardized term "配方" in the sentence
that currently reads "食谱唯一 ID (Recipe Unique ID)"; locate the string "食谱唯一 ID
(Recipe Unique ID)" in the curl-to-rss.md content and change it to "配方唯一 ID
(Recipe Unique ID)" so the documentation consistently uses "Recipe (配方)" per
guidelines.
| 审查你的配置并将其保存为永久食谱。 | ||
|
|
||
| - **食谱唯一 ID (Recipe Unique ID)**：此订阅源配置的唯一标识符（例如 `tech-blog-feed`）。如果留空，将自动根据订阅源标题生成。 | ||
| - **食谱唯一 ID (Recipe Unique ID)**：此订阅源配置的唯一标识符（例如 `tech-blog-feed`）。它会根据订阅源标题自动预填充，你也可以点击 **刷新** 图标重新生成。 |
There was a problem hiding this comment.
统一术语为“配方”而非“食谱”。
此行使用“食谱”，与规范要求的 Recipe（配方）不一致，建议替换为“配方”。
As per coding guidelines: “Use 'AtomCraft' … and 'Recipe' (配方) consistently across all documentation.”
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@doc-site/src/content/docs/zh/guides/advanced/html-to-rss.md` at line 64,
Replace the Chinese term “食谱” with the standard term “配方” in the sentence
containing "食谱唯一 ID (Recipe Unique ID)"; update the text to read “配方唯一 ID
(Recipe Unique ID)” and ensure any adjacent occurrences (e.g., the phrase about
auto-filling from the feed title and the “刷新” icon description) use “配方”
consistently to match the project's terminology for Recipe/配方.
1 participant
User description
What Changed 💡
html-to-rss.md(EN/ZH) to reflect auto-generation and refresh button.curl-to-rss.md(EN/ZH) to reflect auto-generation and refresh button.search-to-rss.md(EN/ZH) to reflect auto-generation and refresh button.Why 📖
Recent code changes (#8cb82c2) introduced a feature to auto-generate the Recipe ID from the feed title using
limaxand added a refresh button in the UI. The documentation needed to be synced to explain this new behavior.Files Updated
doc-site/src/content/docs/en/guides/advanced/html-to-rss.mddoc-site/src/content/docs/en/guides/advanced/curl-to-rss.mddoc-site/src/content/docs/en/guides/advanced/search-to-rss.mddoc-site/src/content/docs/zh/guides/advanced/html-to-rss.mddoc-site/src/content/docs/zh/guides/advanced/curl-to-rss.mddoc-site/src/content/docs/zh/guides/advanced/search-to-rss.mdVerification 🔍
pnpm buildindoc-site)PR created automatically by Jules for task 11660376846738385854 started by @Colin-XKL
PR Type
Documentation
Description
Updated Recipe ID documentation across six RSS wizard guides
Clarified auto-generation behavior with pre-filled IDs from feed titles
Added mention of Refresh icon for ID regeneration
Synchronized documentation for EN and ZH locales
Diagram Walkthrough
File Walkthrough
curl-to-rss.md
Clarify auto-filled Recipe ID with refresh capabilitydoc-site/src/content/docs/en/guides/advanced/curl-to-rss.md
pre-filled with refresh option"
html-to-rss.md
Clarify auto-filled Recipe ID with refresh capabilitydoc-site/src/content/docs/en/guides/advanced/html-to-rss.md
pre-filled with refresh option"
search-to-rss.md
Clarify auto-filled Recipe ID with refresh capabilitydoc-site/src/content/docs/en/guides/advanced/search-to-rss.md
with refresh option"
curl-to-rss.md
Clarify auto-filled Recipe ID with refresh capabilitydoc-site/src/content/docs/zh/guides/advanced/curl-to-rss.md
pre-filled with refresh option"
html-to-rss.md
Clarify auto-filled Recipe ID with refresh capabilitydoc-site/src/content/docs/zh/guides/advanced/html-to-rss.md
pre-filled with refresh option"
search-to-rss.md
Clarify auto-filled Recipe ID with refresh capabilitydoc-site/src/content/docs/zh/guides/advanced/search-to-rss.md
refresh option"