docs(cli): add docs for doctor --timeout and --retries flags - #484
Merged
Conversation
In the CLI docs page's Doctor section, add the two new hosted-probe flags: `--timeout <ms>` (per-probe hosted request timeout, default 15000, accepts 100–120000) and `--retries <0-5>` (retries for safe hosted GET/HEAD probes, default 1), and note that mutating MCP requests are never retried automatically. Include the combined example `docs doctor --agent --url https://docs.example.com --timeout 20000 --retries 2`. Generated by Docs Cloud via https://docs.farming-labs.dev
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
@farming-labs/astro
@farming-labs/astro-theme
@farming-labs/docs
@farming-labs/farmjs
@farming-labs/theme
@farming-labs/next
@farming-labs/nuxt
@farming-labs/nuxt-theme
@farming-labs/svelte
@farming-labs/svelte-theme
@farming-labs/tanstack-start
commit: |
Kinfe123
approved these changes
Aug 17, 2026
Kinfe123
marked this pull request as ready for review
August 17, 2026 10:12
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Your trial has ended. Reactivate Greptile to resume code reviews.
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
1 participant
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.
Updates documentation after #480 changed behavior that readers may rely on.
What Changed
The
docs doctorCLI gained two new options for hosted URL probes:--timeout <ms>sets each hosted HTTP probe timeout (default 15000, valid range 100–120000) and--retries <0-5>sets the retry count for safe hosted GET/HEAD probes (default 1, valid range 0–5). Invalid values throw descriptive errors, and mutating MCP requests are never retried automatically. These surface onDoctorOptionsashostedTimeoutMsandhostedRetriesand appear in the doctor help output. Separately, the docs sitemap response Cache-Control header default changed frompublic, max-age=0, must-revalidatetopublic, max-age=0, s-maxage=3600, stale-while-revalidate=86400.Docs Update
In the CLI docs page's Doctor section, add the two new hosted-probe flags:
--timeout <ms>(per-probe hosted request timeout, default 15000, accepts 100–120000) and--retries <0-5>(retries for safe hosted GET/HEAD probes, default 1), and note that mutating MCP requests are never retried automatically. Include the combined exampledocs doctor --agent --url https://docs.example.com --timeout 20000 --retries 2.Generated by Docs Cloud.
Summary by cubic
Documents the new
--timeoutand--retriesflags fordocs doctorhosted probes so users can tune timeouts and retry behavior and understand defaults and limits. Previously these options were undocumented.--timeout <ms>: per-probe HTTP timeout (default 15000, range 100–120000).--retries <0-5>: retries for safe GET/HEAD probes (default 1); mutating MCP requests are never retried. An example command is added.Written for commit a830504. Summary will update on new commits.