chore: docs and post release improvements#10841
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
14 issues found across 59 files
Confidence score: 3/5
- This is mostly documentation risk (not core runtime code), but several high-confidence inaccuracies could mislead users, so there is some merge risk.
- Most severe:
docs/zh/pages/advanced/interceptors.mdpresents full interceptor execution output without actually making a request, which can fabricate expected behavior for readers. - Timeout and config guidance is inconsistent across locales (for example
docs/pages/advanced/error-handling.mdanddocs/fr/pages/advanced/error-handling.mdonclarifyTimeoutError, plusdocs/pages/advanced/request-config.mdXSRF notes), creating concrete user-facing confusion. - Pay close attention to
docs/zh/pages/advanced/interceptors.md,docs/pages/advanced/error-handling.md,docs/fr/pages/advanced/error-handling.md,docs/zh/pages/advanced/request-config.md, anddocs/pages/advanced/request-config.md- examples and option descriptions currently contradict documented behavior.
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="docs/fr/pages/advanced/error-handling.md">
<violation number="1" location="docs/fr/pages/advanced/error-handling.md:97">
P2: Custom agent: **Flag AI Slop and Fabricated Changes**
The timeout example contradicts the surrounding text: it says `clarifyTimeoutError: true` enables `ETIMEDOUT`, but the example sets `clarifyTimeoutError: false`, which misrepresents the documented behavior.</violation>
</file>
<file name="docs/zh/pages/advanced/interceptors.md">
<violation number="1" location="docs/zh/pages/advanced/interceptors.md:108">
P2: Custom agent: **Flag AI Slop and Fabricated Changes**
Example claims complete interceptor execution output, but no request is ever made to trigger the interceptors.</violation>
</file>
<file name="docs/es/pages/advanced/x-www-form-urlencoded-format.md">
<violation number="1" location="docs/es/pages/advanced/x-www-form-urlencoded-format.md:32">
P2: Custom agent: **Flag AI Slop and Fabricated Changes**
The example references an undefined `url`, making the new docs snippet incomplete and low-quality.</violation>
</file>
<file name=".github/PULL_REQUEST_TEMPLATE.md">
<violation number="1" location=".github/PULL_REQUEST_TEMPLATE.md:20">
P3: Custom agent: **Flag AI Slop and Fabricated Changes**
Standalone dash under the Changes section is placeholder filler text shipped in the template.</violation>
</file>
<file name="docs/pages/advanced/error-handling.md">
<violation number="1" location="docs/pages/advanced/error-handling.md:97">
P2: The timeout example contradicts the documented behavior by setting `clarifyTimeoutError` to `false` while describing the `true` configuration for `ETIMEDOUT`.</violation>
</file>
<file name="docs/es/pages/advanced/error-handling.md">
<violation number="1" location="docs/es/pages/advanced/error-handling.md:97">
P2: El ejemplo contradice la explicación: para demostrar `ETIMEDOUT` debe usar `clarifyTimeoutError: true`, no `false`.</violation>
</file>
<file name="docs/pages/advanced/x-www-form-urlencoded-format.md">
<violation number="1" location="docs/pages/advanced/x-www-form-urlencoded-format.md:32">
P2: The new docs example uses an undefined `url` variable, so the sample code fails at runtime.</violation>
</file>
<file name="docs/zh/pages/advanced/x-www-form-urlencoded-format.md">
<violation number="1" location="docs/zh/pages/advanced/x-www-form-urlencoded-format.md:32">
P2: 示例中的 `url` 未定义,会导致复制示例后运行时报错。请改为显式 URL 字符串或先定义 `url` 变量。</violation>
</file>
<file name="docs/fr/pages/advanced/x-www-form-urlencoded-format.md">
<violation number="1" location="docs/fr/pages/advanced/x-www-form-urlencoded-format.md:32">
P3: The example uses an undefined `url` identifier, so the snippet will throw a ReferenceError when copied. Use a concrete URL or define the variable in the snippet.</violation>
</file>
<file name="docs/zh/pages/advanced/error-handling.md">
<violation number="1" location="docs/zh/pages/advanced/error-handling.md:95">
P3: The example sets `clarifyTimeoutError` to `false` even though the comment says to set it to `true` to get `ETIMEDOUT`. This is inconsistent and will mislead readers about how to enable ETIMEDOUT.</violation>
</file>
<file name="docs/zh/pages/advanced/request-config.md">
<violation number="1" location="docs/zh/pages/advanced/request-config.md:6">
P2: The new security warning incorrectly implies `maxBodyLength` protects against response decompression bombs; only `maxContentLength` applies to response size.</violation>
<violation number="2" location="docs/zh/pages/advanced/request-config.md:48">
P3: The compatibility note for reviver `context` is inaccurate: this is not an ES2023+ baseline feature.</violation>
<violation number="3" location="docs/zh/pages/advanced/request-config.md:367">
P2: `silentJSONParsing: true` is documented incorrectly: Axios swallows parse errors but keeps the original response string rather than setting `response.data` to `null`.</violation>
</file>
<file name="docs/pages/advanced/request-config.md">
<violation number="1" location="docs/pages/advanced/request-config.md:219">
P2: The new XSRF guidance is inaccurate: sending the XSRF header is controlled by `withXSRFToken`, not strictly by also setting `withCredentials`.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
Co-authored-by: cubic-dev-ai[bot] <191113872+cubic-dev-ai[bot]@users.noreply.github.com>
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 by cubic
Post-release cleanup to streamline contributor docs, add the v1.16.0 changelog, and update multi-language docs with new features, security notes, and clarifications. Also updates
.gitignoreand removescrowdin.yml.Description
.github/copilot-instructions.md: reduced to a stub pointing to canonicalAGENTS.md.AGENTS.md: expanded architecture overview (platform/adapters), setup/safety, testing, and boundaries.CHANGELOG.md: adds v1.16.0 (QUERY method,ECONNREFUSED, adapter fixes across redirects/aborts/headers/timeouts).maxBodyLength/maxContentLength; summary of other security-sensitive options.getUri; interceptor execution order; NodeFormDataheader policy (formDataHeaderPolicy); new errorERR_FORM_DATA_DEPTH_EXCEEDED; improved TypeScript import/resolution guidance.application/x-www-form-urlencodedexamples withqsand explicit header control; FileList upload via"files[]"; HTML form path-collision tip.parseReviverdetails.crowdin.yml; add.claude/to.gitignore.Docs
/docs/after merge. Verify anchors and cross-language parity for updated pages (e.g., request config security notes,getUri, HTTP/2 redirects,formDataHeaderPolicy, error redaction/timeout handling,"files[]"upload, HTML path-collision tip, and zhparseReviver). Ensure release notes include v1.16.0.Testing
Semantic version impact
Written for commit 0fbd02b. Summary will update on new commits.