docs: align ruby gem guides with current config behavior#1083
Merged
gildesmarais merged 3 commits intomainfrom Mar 10, 2026
Merged
docs: align ruby gem guides with current config behavior#1083gildesmarais merged 3 commits intomainfrom
gildesmarais merged 3 commits intomainfrom
Conversation
gildesmarais
commented
Mar 10, 2026
gildesmarais
commented
Mar 10, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Ruby gem documentation to better match the current CLI/config surface, with examples rewritten as complete, valid feed configs and selector pagination guidance consolidated into the selectors reference.
Changes:
- Reworks CLI and reference pages to reflect current commands/config structure (e.g.,
schema,validate, top-levelstrategy). - Moves/expands pagination documentation into the selectors reference and documents expected behavior.
- Updates guides/tutorials to use complete, valid YAML configs (and modernizes examples like HTTPS + JSON selector shapes).
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
src/content/docs/ruby-gem/tutorials/your-first-feed.mdx |
Simplifies the selectors tutorial example and makes the config more realistic/complete. |
src/content/docs/ruby-gem/reference/stylesheets.mdx |
Makes the stylesheet example a full feed config (channel + selectors included). |
src/content/docs/ruby-gem/reference/strategy.mdx |
Clarifies top-level strategy placement and updates CLI usage examples. |
src/content/docs/ruby-gem/reference/selectors.mdx |
Adds a dedicated “Paginated Feeds” section with config and behavior notes. |
src/content/docs/ruby-gem/reference/headers.mdx |
Turns the headers snippet into a complete, valid feed config example. |
src/content/docs/ruby-gem/reference/cli-reference.mdx |
Replaces the old CLI writeup with a clearer command-oriented reference (auto/feed/schema/validate/help/version). |
src/content/docs/ruby-gem/reference/channel.mdx |
Provides a complete channel-in-context example plus runtime notes for common pitfalls. |
src/content/docs/ruby-gem/reference/auto-source.mdx |
Ensures examples include channel.url context for valid configs. |
src/content/docs/ruby-gem/how-to/scraping-json.mdx |
Updates examples to HTTPS and includes required selectors (items, title, url). |
src/content/docs/ruby-gem/how-to/managing-feed-configs.mdx |
Replaces placeholder selector blocks with concrete, valid per-feed examples. |
src/content/docs/ruby-gem/how-to/dynamic-parameters.mdx |
Updates the example to a complete config and adds clarifying notes about parameterization scope. |
src/content/docs/ruby-gem/how-to/custom-http-requests.mdx |
Makes all header examples complete configs and aligns dynamic header placeholders to %<param>s. |
src/content/docs/ruby-gem/how-to/advanced-features.mdx |
Updates examples to include required channel/url selectors so snippets are valid configs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This updates the Ruby gem documentation on the website so the examples and command reference match the current gem behavior more closely.
What changed
Commit slices
docs(ruby-gem): align reference pages with current config surfacedocs(ruby-gem): make guides and tutorials use valid configsValidation
mise exec -- ruby -Ilib -rhtml2rsshttp://localhost:4321Notes
examples/directory out of the PR