docs: update RSS wizard guides for auto-generated recipe IDs (#8cb82c2)#558
docs: update RSS wizard guides for auto-generated recipe IDs (#8cb82c2)#558
Conversation
- Updated "Save Recipe" steps in `html-to-rss.md`, `curl-to-rss.md`, and `search-to-rss.md` (both `en` and `zh`). - Documented the auto-fill behavior for Recipe Unique IDs. - Added details about strict validation (`[a-z0-9-]`) and the new Refresh button. Co-authored-by: Colin-XKL <49122401+Colin-XKL@users.noreply.github.com>
|
👋 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. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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 updates the documentation for the RSS wizard guides to align with recent changes in how Recipe Unique IDs are managed. The updates provide users with accurate information on the auto-generation, strict validation rules, and the new refresh functionality for these IDs, ensuring the guides reflect the current user experience. 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
|
ⓘ 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 the documentation for the RSS wizard guides to reflect new features for the 'Recipe Unique ID', including auto-generation, format validation, and a refresh button. The changes are applied consistently across English and Chinese versions of the html-to-rss, curl-to-rss, and search-to-rss guides.
My review focuses on improving documentation consistency. I've suggested aligning the terminology for the recipe identifier in the search-to-rss.md guides (both English and Chinese) with other guides and with URL placeholders within the same files. This will help prevent user confusion.
| 1. **Recipe ID**: Choose a unique identifier for this recipe (e.g., `search-ai-news`). | ||
| - **Auto-Fill**: This field is automatically populated from the feed title. | ||
| - **Format**: Only lowercase letters, numbers, and hyphens (`[a-z0-9-]`) are allowed. | ||
| - **Refresh**: You can manually regenerate the ID from the title using the refresh button. |
There was a problem hiding this comment.
For consistency with other guides (like curl-to-rss.md) and the URL placeholder {recipe-unique-id} on line 56, consider renaming Recipe ID to Recipe Unique ID. This will improve clarity for users.
| 1. **Recipe ID**: Choose a unique identifier for this recipe (e.g., `search-ai-news`). | |
| - **Auto-Fill**: This field is automatically populated from the feed title. | |
| - **Format**: Only lowercase letters, numbers, and hyphens (`[a-z0-9-]`) are allowed. | |
| - **Refresh**: You can manually regenerate the ID from the title using the refresh button. | |
| 1. **Recipe Unique ID**: Choose a unique identifier for this recipe (e.g., `search-ai-news`). | |
| - **Auto-Fill**: This field is automatically populated from the feed title. | |
| - **Format**: Only lowercase letters, numbers, and hyphens (`[a-z0-9-]`) are allowed. | |
| - **Refresh**: You can manually regenerate the ID from the title using the refresh button. |
| 1. **配方 ID (Recipe ID)**：为此配方选择一个唯一的标识符（例如 `search-ai-news`）。 | ||
| - **自动填充 (Auto-Fill)**：该字段将根据订阅源标题自动填充。 | ||
| - **格式 (Format)**：仅允许小写字母、数字和连字符 (`[a-z0-9-]`)。 | ||
| - **刷新 (Refresh)**：你可以使用刷新按钮根据标题手动重新生成 ID。 |
There was a problem hiding this comment.
For consistency with other guides (e.g., curl-to-rss.md) and the URL placeholder {recipe-unique-id} on line 56, consider renaming 配方 ID (Recipe ID) to 食谱唯一 ID (Recipe Unique ID). This also involves changing 配方 to 食谱 in the description to align terminology across all Chinese documentation.
| 1. **配方 ID (Recipe ID)**：为此配方选择一个唯一的标识符（例如 `search-ai-news`）。 | |
| - **自动填充 (Auto-Fill)**：该字段将根据订阅源标题自动填充。 | |
| - **格式 (Format)**：仅允许小写字母、数字和连字符 (`[a-z0-9-]`)。 | |
| - **刷新 (Refresh)**：你可以使用刷新按钮根据标题手动重新生成 ID。 | |
| 1. **食谱唯一 ID (Recipe Unique ID)**：为此食谱选择一个唯一的标识符（例如 `search-ai-news`）。 | |
| - **自动填充 (Auto-Fill)**：该字段将根据订阅源标题自动填充。 | |
| - **格式 (Format)**：仅允许小写字母、数字和连字符 (`[a-z0-9-]`)。 | |
| - **刷新 (Refresh)**：你可以使用刷新按钮根据标题手动重新生成 ID。 |
WalkthroughThis PR updates documentation in six guides (English and Chinese versions) to explicitly describe the Recipe Unique ID field's auto-fill, format constraints, and refresh capabilities in the Save Recipe step, replacing implicit behavior descriptions with detailed itemized documentation. 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 |
Reviewer's GuideUpdates RSS wizard documentation in both English and Chinese guides to describe the new Recipe ID behavior, including auto-fill from title, strict ID format validation, and the manual refresh/regeneration option in the “Save Recipe” step across HTML-to-RSS, cURL-to-RSS, and Search-to-RSS flows. Sequence diagram for Recipe ID auto-fill and validation in RSS wizardsequenceDiagram
actor User
participant WizardUI
participant RecipeIdField
participant ValidationEngine
User->>WizardUI: Open_RSS_wizard
WizardUI->>RecipeIdField: Initialize_field
User->>WizardUI: Enter_feed_title
WizardUI->>RecipeIdField: Auto_fill_from_title
User->>RecipeIdField: Edit_Recipe_ID_optional
RecipeIdField->>ValidationEngine: Validate_ID_value
ValidationEngine-->>RecipeIdField: Result_valid_or_error
User->>RecipeIdField: Click_refresh_button
RecipeIdField->>WizardUI: Request_title_value
WizardUI-->>RecipeIdField: Title_value
RecipeIdField->>RecipeIdField: Regenerate_ID_from_title
RecipeIdField->>ValidationEngine: Validate_regenerated_ID
ValidationEngine-->>RecipeIdField: Result_valid
User->>WizardUI: Click_confirm_and_save
WizardUI->>ValidationEngine: Final_ID_validation
ValidationEngine-->>WizardUI: Validation_passed
WizardUI-->>User: Recipe_saved_successfully
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- In the Search-to-RSS guides (EN and ZH), the updated Recipe ID section no longer mentions that the ID becomes part of the feed URL; if that behavior is still correct, consider keeping a short note about the URL impact to help users choose IDs carefully.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the Search-to-RSS guides (EN and ZH), the updated Recipe ID section no longer mentions that the ID becomes part of the feed URL; if that behavior is still correct, consider keeping a short note about the URL impact to help users choose IDs carefully.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![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
🧹 Nitpick comments (1)
doc-site/src/content/docs/en/guides/advanced/search-to-rss.md (1)
44-47: Consider aligning the label to “Recipe Unique ID” for cross-guide consistency.This page uses
Recipe ID, while related guides useRecipe Unique ID. Using the same label everywhere would reduce ambiguity.🤖 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 44 - 47, Update the label text "Recipe ID" to "Recipe Unique ID" (and adjust the related inline descriptions "Auto-Fill", "Format", "Refresh" if they reference the old label) so this guide matches the naming used across related guides; search for the literal string "Recipe ID" (and the example `search-ai-news`) in this document and replace it with "Recipe Unique ID", ensuring the description about auto-population, allowed format `[a-z0-9-]`, and the refresh behavior remain accurate and consistent.
🤖 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/curl-to-rss.md`:
- Around line 66-69: Add the same "Recipe Unique ID" guidance to the Traditional
Chinese (zh-tw) version of the same guide: mirror the four bullet points
("Recipe Unique ID", "Auto-Fill", "Format", "Refresh") with equivalent zh-tw
wording and keep the formatting (code span for `[a-z0-9-]`) and examples (e.g.,
`my-custom-api-feed`); ensure the zh-tw curl-to-rss guide contains the exact
behavior notes about auto-population from the title, allowed characters, and the
manual refresh button so en/zh/zh-tw are synchronized.
In `@doc-site/src/content/docs/zh/guides/advanced/curl-to-rss.md`:
- Around line 66-69: Replace the incorrect Chinese term "食谱" with the required
project term "配方" in the doc content where the heading and related lines use
"**食谱唯一 ID (Recipe Unique ID)**" — update that heading and any inline
occurrences (e.g., the lines describing Auto-Fill, Format, Refresh) so they read
"**配方唯一 ID (Recipe Unique ID)**" and maintain the existing English
parenthetical; ensure consistency with other docs using "Recipe (配方)".
In `@doc-site/src/content/docs/zh/guides/advanced/html-to-rss.md`:
- Around line 64-67: The documentation block uses the term "食谱唯一 ID" which
violates the repository terminology rule requiring "配方" for Recipe; update the
phrase and any adjacent occurrences (e.g., the header and the "自动填充", "格式", and
"刷新" lines) to use "配方唯一 ID" and ensure the nearby Save button/text also uses
"配方" instead of "食谱"; review the surrounding paragraphs in the same section to
replace any other instances of "食谱" with "配方" so the doc consistently uses the
designated term.
---
Nitpick comments:
In `@doc-site/src/content/docs/en/guides/advanced/search-to-rss.md`:
- Around line 44-47: Update the label text "Recipe ID" to "Recipe Unique ID"
(and adjust the related inline descriptions "Auto-Fill", "Format", "Refresh" if
they reference the old label) so this guide matches the naming used across
related guides; search for the literal string "Recipe ID" (and the example
`search-ai-news`) in this document and replace it with "Recipe Unique ID",
ensuring the description about auto-population, allowed format `[a-z0-9-]`, and
the refresh behavior remain accurate and consistent.
ℹ️ 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
| - **Recipe Unique ID**: A unique identifier for this feed configuration (e.g., `my-custom-api-feed`). | ||
| - **Auto-Fill**: This field is automatically populated from the feed title. | ||
| - **Format**: Only lowercase letters, numbers, and hyphens (`[a-z0-9-]`) are allowed. | ||
| - **Refresh**: You can manually regenerate the ID from the title using the refresh button. |
There was a problem hiding this comment.
Please sync this new Recipe ID guidance to zh-tw docs in the same PR.
The update is mirrored in en/zh, but this task also requires zh-tw parity for the same guides. Please add equivalent zh-tw updates for these Recipe ID behavior changes before merge.
Based on learnings, "FeedCraft documentation MUST be kept in sync across all supported languages (en, zh, zh-tw). Every single update or modification MUST be applied to ALL language versions in the same turn/task."
🤖 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/curl-to-rss.md` around lines 66
- 69, Add the same "Recipe Unique ID" guidance to the Traditional Chinese
(zh-tw) version of the same guide: mirror the four bullet points ("Recipe Unique
ID", "Auto-Fill", "Format", "Refresh") with equivalent zh-tw wording and keep
the formatting (code span for `[a-z0-9-]`) and examples (e.g.,
`my-custom-api-feed`); ensure the zh-tw curl-to-rss guide contains the exact
behavior notes about auto-population from the title, allowed characters, and the
manual refresh button so en/zh/zh-tw are synchronized.
| - **食谱唯一 ID (Recipe Unique ID)**：此订阅源配置的唯一标识符（例如 `my-custom-api-feed`）。 | ||
| - **自动填充 (Auto-Fill)**：该字段将根据订阅源标题自动填充。 | ||
| - **格式 (Format)**：仅允许小写字母、数字和连字符 (`[a-z0-9-]`)。 | ||
| - **刷新 (Refresh)**：你可以使用刷新按钮根据标题手动重新生成 ID。 |
There was a problem hiding this comment.
Please replace “食谱” with the required “配方” terminology here.
The new 食谱唯一 ID wording conflicts with the project’s required Recipe terminology (配方).
As per coding guidelines, "Use 'AtomCraft' (原子工藝/原子工艺), 'FlowCraft' (組合工藝/组合工艺), 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` around lines 66
- 69, Replace the incorrect Chinese term "食谱" with the required project term
"配方" in the doc content where the heading and related lines use "**食谱唯一 ID
(Recipe Unique ID)**" — update that heading and any inline occurrences (e.g.,
the lines describing Auto-Fill, Format, Refresh) so they read "**配方唯一 ID (Recipe
Unique ID)**" and maintain the existing English parenthetical; ensure
consistency with other docs using "Recipe (配方)".
| - **食谱唯一 ID (Recipe Unique ID)**：此订阅源配置的唯一标识符（例如 `tech-blog-feed`）。 | ||
| - **自动填充 (Auto-Fill)**：该字段将根据订阅源标题自动填充。 | ||
| - **格式 (Format)**：仅允许小写字母、数字和连字符 (`[a-z0-9-]`)。 | ||
| - **刷新 (Refresh)**：你可以使用刷新按钮根据标题手动重新生成 ID。 |
There was a problem hiding this comment.
Use the required “配方” term consistently in this new block.
This changed section uses 食谱唯一 ID, which conflicts with the repository terminology rule for Recipe (配方). Please align this block (and nearby Save text) to 配方.
As per coding guidelines, "Use 'AtomCraft' (原子工藝/原子工艺), 'FlowCraft' (組合工藝/组合工艺), 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` around lines 64
- 67, The documentation block uses the term "食谱唯一 ID" which violates the
repository terminology rule requiring "配方" for Recipe; update the phrase and any
adjacent occurrences (e.g., the header and the "自动填充", "格式", and "刷新" lines) to
use "配方唯一 ID" and ensure the nearby Save button/text also uses "配方" instead of
"食谱"; review the surrounding paragraphs in the same section to replace any other
instances of "食谱" with "配方" so the doc consistently uses the designated term.
1 participant
User description
What Changed 💡
html-to-rss.md,curl-to-rss.md, andsearch-to-rss.md(bothenandzh).[a-z0-9-]) and the new Refresh button.Why 📖
Recent code changes ([#8cb82c2]) introduced auto-generation and strict validation for Recipe IDs in the RSS wizards, which requires documentation sync to guide users correctly.
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 7897192575607688520 started by @Colin-XKL
PR Type
Documentation
Description
Updated Recipe ID documentation across RSS wizard guides
Added auto-fill behavior and format validation details
Documented refresh button functionality for ID regeneration
Synchronized changes across English and Chinese guides
Diagram Walkthrough
File Walkthrough
curl-to-rss.md
Enhanced Recipe ID documentation with validation detailsdoc-site/src/content/docs/en/guides/advanced/curl-to-rss.md
[a-z0-9-]html-to-rss.md
Enhanced Recipe ID documentation with validation detailsdoc-site/src/content/docs/en/guides/advanced/html-to-rss.md
[a-z0-9-]search-to-rss.md
Enhanced Recipe ID documentation with validation detailsdoc-site/src/content/docs/en/guides/advanced/search-to-rss.md
[a-z0-9-]curl-to-rss.md
Enhanced Recipe ID documentation with validation detailsdoc-site/src/content/docs/zh/guides/advanced/curl-to-rss.md
Chinese
[a-z0-9-]html-to-rss.md
Enhanced Recipe ID documentation with validation detailsdoc-site/src/content/docs/zh/guides/advanced/html-to-rss.md
Chinese
[a-z0-9-]search-to-rss.md
Enhanced Recipe ID documentation with validation detailsdoc-site/src/content/docs/zh/guides/advanced/search-to-rss.md
Chinese
[a-z0-9-]Summary by Sourcery
Documentation: