Repository navigation
Nest the common.ai docs sidebar and lead with features and providers - #73548
Merged
Merged
Conversation
The sidebar listed every page flat under nine captions, so a reader saw about fifty entries and had to know class names to pick a page. Every toctree also carried maxdepth 1, which stopped the Airflow theme from rendering the nested pages it already supports. The sidebar is now Basics, Getting started (installation, quick start, core concepts) and seven expandable guides: What you can build, Models and providers, Operators, Toolsets, LLM and agent features, Document and RAG pipelines, and Reliability and operations. Each guide is a page that lists its children, and the theme expands the branch the reader is in. Sidebar labels lead with the feature rather than the class name, and page titles carry both. A new supported-providers page maps each vendor to its model prefix, extra, connection type and credentials, including Snowflake Cortex, and links to the anchored connection examples. The classifier models page links TypeSafe's site and documentation.
vatsrahul1001
approved these changes
Sep 22, 2026
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.
After #73523 and #73542 the
common.aisidebar lists about fifty pages flat under nine captions, and most labels are class names (LLMBranchOperator,HookToolset), so a reader has to know the API to pick a page. Every toctree also carried:maxdepth: 1, which stopped the Airflow theme from rendering nested pages at all: the sandbox configuration and backends pages, and the MCP connection and hook pages, were reachable only from inside their parent page.This PR turns the sidebar into the shape the Pydantic AI docs use. Basics and Getting started (installation, quick start, core concepts) stay flat; below them sit seven expandable guides: What you can build, Models and providers, Operators, Toolsets, LLM and agent features, Document and RAG pipelines, and Reliability and operations. Each guide is a page that lists its children, and the theme expands the branch the reader is in, down to a third level for MCP servers and sandboxed execution under Toolsets. Labels lead with the feature ("Branch on an answer", "Airflow hooks as tools") and page titles carry both the feature and the class name, so search and the API reference still find the class.
A new supported-providers page maps each vendor to its model prefix, extra, connection type and credential location, including Snowflake Cortex, and links each vendor to an anchored example on the connection reference. The classifier models page now links TypeSafe's site and documentation.
Design rationale
The theme already supports the nested tree; the provider was suppressing it.
sphinx_airflow_themerenderstoctree(collapse=True)and expands the current branch with CSS, exactly as the core Airflow docs use it. Our:maxdepth: 1capped the global tree at one level, and without:titlesonly:the sidebar would list each page's section headings as extra levels. Both are set on every toctree now. What the theme does not support is click-to-expand of inactive branches, which is why each parent page also lists its children in the body.Core concepts is an overview under Getting started, not a container. Structured output, message history, guardrails, code mode and the two review pages are feature guides, and a reader looking for human approval would not look under "concepts". They live under "LLM and agent features", with the review pages labelled "Approve outputs" and "Review agent sessions" so the distinction is visible in the sidebar.
Sandboxed execution moved under Toolsets. It is
SandboxToolset, and the Pydantic AI docs place their sandbox under tools and capabilities rather than at the top level.Provider fallback is listed under both Models and providers and Reliability and operations. It is configured on the connection, but a reader handling a provider outage looks under operations. The page has one home in the toctree and a cross-linking bullet in the other.
Gotchas
check-system-tests-tocshook requires.{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.