Fix stale and duplicated content in the common.ai provider docs - #73567
Merged
Merged
Conversation
kaxil
marked this pull request as ready for review
September 22, 2026 17:58
vatsrahul1001
approved these changes
Sep 23, 2026
The navigation reorg moved pages without rewriting them. This pass fixes what the words say. Correctness: the schema-compare page described the default context strategy as an opt-in and its parameter bullet was garbled; the LangChain connection page called Anthropic OpenAI-compatible when the real criterion is a model class that accepts api_key and base_url; the two TypeSafe pages gave different install commands; the LLM operator page omitted fallback_conn_ids; the document loader example passed an OpenAI connection to an operator that needs a llamaindex one. Duplication: the connection-type rename note lives once in troubleshooting, the MCP token_provider and env_provider explanation lives on the toolset page, the LlamaIndex OpenAI-only story lives on the hook page, the model resolution order is one list on the connection page, and the HITL review parameters are documented once. Removed review-process language, version-pinned claims and one set of measured calibration numbers that would rot. One OpenAI id and one Anthropic id are used across the tree, plus a cheap variant of each; the invented gpt-5.6-sol is gone from the quick start and the connection form. Em dashes, tilde underlines, unquoted extras and the PydanticAI spelling are normalized.
kaxil
force-pushed
the
commonai-docs-content
branch
from
September 23, 2026 09:30
96ed370 to
a087fc9
Compare
zozo123
added a commit
to zozo123/airflow
that referenced
this pull request
Sep 24, 2026
Resolve conflicts with the common.ai docs rewrite on main (apache#73567, apache#73589): keep main's wording and style, and add OpenSandbox where main lists the shipped backends. - installation.rst: take main's parenthesized extras list, keep ``opensandbox`` in the agent-tooling group. - sandbox/index.rst: "Three backends ship"; add an OpenSandboxBackend row to the new "What enforces the boundary" table and cover it in the teardown paragraph that follows. - sandbox/backends.rst: take main's Modal CPU default, keep the OpenSandbox CPU note; stop calling Modal the only backend that runs on Kubernetes, which the OpenSandbox section contradicts.
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.
The
common.aidocs were reorganized recently without rewriting the pages, and a read of every page afterwards found problems in the words rather than the structure. This PR fixes them. No page moves; the sidebar is unchanged.Correctness. The schema-compare page told readers to set
context_strategy="full"to get keys and indexes, but that is the default; the section now shows opting down to"basic"and the parameter bullet, which was garbled, is rewritten. The LangChain connection page called Anthropic OpenAI-compatible; the real criterion is a LangChain model class that acceptsapi_keyandbase_url, and the page, the hook page and the hook docstring now say so. The two TypeSafe pages gave different install commands and now agree on the provider'stypesafeextra. The LLM operator page listsfallback_conn_ids, which the operator accepts. The document loader example passes allamaindexconnection to the LlamaIndex embedding operator instead of an OpenAI one.Duplication. Each explanation now has one home and the other pages link to it: the connection-type rename note (troubleshooting), the MCP
token_providerandenv_providercallables (the toolset page, with the connection page keeping the fields), the LlamaIndex OpenAI-only model check (the hook page), the model resolution order (the connection page, now including the spec-file case that only the hook page mentioned) and the HITL review parameters (the review page).Stale text. Review-process language ("pre-PR behavior", "tracked as a follow-up", "left out of this change", a "roadmap" section) is gone, as are version-pinned claims ("2.46+", "verified against 2.23.0 and 2.31.1", "legacy flag from 1.x") and a paragraph quoting calibration scores from one classifier release. The one version that stays is the
pydantic-ai-slimrelease that ships the TypeSafe adapter, on the classifier page, because the provider's extra does not pin it (raising that floor is a dependency change, not a docs one).Model ids. The tree used four OpenAI ids, one of them invented (
gpt-5.6-sol, in the quick start and the connection form placeholder). Docs, docstrings,provider.yamland the example Dags now usegpt-5withgpt-5-minias the cheap variant, andclaude-sonnet-5withclaude-haiku-4-5-20251001for Anthropic. Bedrock ids are untouched because they are a different namespace. The per-request batch example keepsgpt-4.1-mini, since it demonstrates atemperatureoverride that the reasoning models reject.Style. Em dashes are replaced with commas, colons or sentence breaks, tilde H3 underlines match the rest of the tree, extras installs are quoted so the brackets survive zsh, and "PydanticAI" is spelled
pydantic-aiwhen it means the library.{pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.