Skip to content

docs: explain *-base features and document the full feature flag set#750

Merged
kylebarron merged 4 commits into
apache:mainfrom
kevinjqliu:kevinjqliu/docs
Jun 12, 2026
Merged

docs: explain *-base features and document the full feature flag set#750
kylebarron merged 4 commits into
apache:mainfrom
kevinjqliu:kevinjqliu/docs

Conversation

@kevinjqliu

@kevinjqliu kevinjqliu commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Which issue does this PR close?

Closes #749.

Rationale for this change

What changes are included in this PR?

Follow up to #724

PR #724 made reqwest optional and introduced *-base provider features, but the crate docs only mentioned them in passing. This PR adds three doc sections to the crate-level module docs, grouped at the bottom as a "configuration" cluster:

  • # Feature Flags — Layering rationale + three reference tables (provider, transport/shared, other), covering cloud-base, cloud, tls-webpki-roots, integration, etc.
  • # Customizing HTTP Clients — Existing section, now cross-references Disabling reqwest.
  • # Disabling reqwest — When to use *-base, a Cargo.toml snippet, and an AmazonS3Builder::with_http_connector example.

Per-provider module docs (aws, azure, gcp, http) now link to the Feature Flags table so readers can see the aws vs aws-base comparison directly. README gains a ## Disabling reqwest section mirroring the lib.rs explainer alongside the existing wasm32-wasip1 build command.

Are there any user-facing changes?

No, docs only

feature flags

@kevinjqliu

Copy link
Copy Markdown
Contributor Author

thanks for the review @kylebarron, i added a screenshot from rendering the "feature flags" section locally

@kylebarron
kylebarron merged commit 2e859ee into apache:main Jun 12, 2026
9 checks passed
@kevinjqliu
kevinjqliu deleted the kevinjqliu/docs branch June 12, 2026 18:59
@alamb

alamb commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Thank you @kevinjqliu and @kylebarron

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document new feature flag system

3 participants