Skip to content

chore: docs and post release improvements#10841

Merged
jasonsaayman merged 18 commits into
v1.xfrom
chore/docs-and-post-release-improvements
May 4, 2026
Merged

chore: docs and post release improvements#10841
jasonsaayman merged 18 commits into
v1.xfrom
chore/docs-and-post-release-improvements

Conversation

@jasonsaayman
Copy link
Copy Markdown
Member

@jasonsaayman jasonsaayman commented May 4, 2026

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 .gitignore and removes crowdin.yml.

Description

  • Summary of changes
    • Issue/PR templates: clearer prompts, Conventional Commits note, and an auto-description hint.
    • .github/copilot-instructions.md: reduced to a stub pointing to canonical AGENTS.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).
    • Docs (en/es/fr/zh):
      • Security: opt-in limits for maxBodyLength/maxContentLength; summary of other security-sensitive options.
      • Config/usage: getUri; interceptor execution order; Node FormData header policy (formDataHeaderPolicy); new error ERR_FORM_DATA_DEPTH_EXCEEDED; improved TypeScript import/resolution guidance.
      • Forms/files: stronger application/x-www-form-urlencoded examples with qs and explicit header control; FileList upload via "files[]"; HTML form path-collision tip.
      • Extras: error redaction guidance; timeout handling notes; zh adds parseReviver details.
    • Housekeeping: remove crowdin.yml; add .claude/ to .gitignore.
  • Reasoning
    • Align docs with v1.16.0 and reduce common support issues by clarifying security-sensitive options and behavior.
  • Additional context
    • Docs and repository metadata only; no runtime code changes.

Docs

  • Build and deploy /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 zh parseReviver). Ensure release notes include v1.16.0.

Testing

  • No tests added; documentation and templates only.
  • Recommendation: run the docs build and a link checker in CI to catch broken anchors and code samples.

Semantic version impact

  • None. Documentation and templates only; no release required.

Written for commit 0fbd02b. Summary will update on new commits.

@jasonsaayman jasonsaayman self-assigned this May 4, 2026
@jasonsaayman jasonsaayman added priority::medium A medium priority commit::docs The PR is related to docs labels May 4, 2026
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md presents 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.md and docs/fr/pages/advanced/error-handling.md on clarifyTimeoutError, plus docs/pages/advanced/request-config.md XSRF 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, and docs/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.

Comment thread docs/fr/pages/advanced/error-handling.md Outdated
Comment thread docs/zh/pages/advanced/interceptors.md
Comment thread docs/es/pages/advanced/x-www-form-urlencoded-format.md Outdated
Comment thread docs/pages/advanced/error-handling.md Outdated
Comment thread docs/es/pages/advanced/error-handling.md Outdated
Comment thread docs/pages/advanced/request-config.md Outdated
Comment thread .github/PULL_REQUEST_TEMPLATE.md
Comment thread docs/fr/pages/advanced/x-www-form-urlencoded-format.md Outdated
Comment thread docs/zh/pages/advanced/error-handling.md Outdated
Comment thread docs/zh/pages/advanced/request-config.md Outdated
jasonsaayman and others added 12 commits May 4, 2026 19:45
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>
@jasonsaayman jasonsaayman merged commit 13fdbec into v1.x May 4, 2026
25 checks passed
@jasonsaayman jasonsaayman deleted the chore/docs-and-post-release-improvements branch May 4, 2026 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

commit::docs The PR is related to docs priority::medium A medium priority

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant