docs: center scraping guidance on auto - #1255
Merged
Merged
Conversation
…as, and error handling
Deepen the public strategy interface around auto and default while keeping HTTP and server adapters behind their implementation seams. Remove migration narration and incomplete deployment side paths so end users can act on scrape outcomes instead of transport internals.
State capture persistence and MCP discovery behavior exactly as implemented while keeping compatibility aliases out of recommended user guidance. Use the runtime UnknownStrategy name in troubleshooting.
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.
What changed
autothe recommended strategy across custom-feed, dynamic-content, CLI, MCP, and troubleshooting docs.defaultas a fixed direct-request override without exposing HTTP adapter implementation details.UnknownStrategytroubleshooting entry against runtime behavior.Why
End users should choose between the normal
autopath and deliberate fixed-mode overrides. HTTP client and web server choices are implementation details; documenting them throughout the user journey made adapter replacements look like user-facing migrations and weakened the strategy interface.Risk
html2rss-web/docker-compose.ymlstill sets the old timeout variable. These docs describe aligned runtime defaults and tell operators to setREQUEST_TIMEOUT_SECONDSexplicitly rather than claiming Compose configures it.Review map
Review map: whole PR is small — start at
src/content/docs/ruby-gem/reference/strategy.mdx, then checksrc/content/docs/ruby-gem/guides/handling-dynamic-content.mdxandsrc/content/docs/web-application/reference/env-variables.mdx.Validation
make lintmake test— 7 files, 25 tests passedmake build— 44 pages built and 58 HTML files indexed