Skip to content

docs(schema): reorder the protocol pages and rename Cancellation - #2964

Merged
benbrandt merged 2 commits into
mainfrom
docs/protocol-nav-order
Nov 20, 2026
Merged

benbrandt merged 2 commits into
mainfrom
docs/protocol-nav-order

Conversation

@benbrandt

Copy link
Copy Markdown
Member

Summary

Two changes to how the protocol pages read in the sidebar.

Page order

The top of the list already follows the connection lifecycle: Initialization, Authentication, Session Setup, then the prompt pages. The rest is now ordered by what each page depends on.

  • Agent Plan follows Tool Calls. Both are session/update messages the Agent sends while a prompt runs.
  • Subagents moves after Session Config Options and Slash Commands. It links to both, and to Elicitation and request cancellation.
  • The protocol-wide pages run Transports, Request Cancellation, Errors, Extensibility, Security Considerations, then Schema.
  • In v1, Session Config Options comes before Session Modes, which it supersedes.
  • The hidden draft groups use the same order. They listed Authentication before Initialization, which is fixed.

Migrating from v1 stays second in the v2 list while v2 is in Preview.

Page title

"Cancellation" is now "Request Cancellation" in v1, v2, and their drafts. The page covers $/cancel_request. session/cancel is on the prompt pages, so the old title read as the wrong topic. The RFD and the stabilization announcement already use the new name.

The URL is unchanged. The "See protocol docs" links that named the page by its old title are updated, and the schema files are regenerated. Only that link text changes in the $/cancel_request descriptions.

Testing

  • npm run generate
  • cargo clippy in the three configurations from npm run check
  • npm run format:check and npm run spellcheck
  • cargo test --all-features

Keep the connection lifecycle order at the top, then order the rest by
what each page depends on. Agent Plan follows Tool Calls, Subagents
moves after the pages it links to, and the protocol-wide pages run
Transports, Cancellation, Errors, Extensibility, Security.

In v1, Session Config Options now comes before Session Modes, which it
supersedes. The hidden draft groups follow the same order.
The page covers `$/cancel_request`. Session cancellation with
`session/cancel` is on the prompt pages, so the old title read as the
wrong topic in the nav. The URL is unchanged.

Update the "See protocol docs" links that named the page by its title
and regenerate the schema files.
@benbrandt
benbrandt requested a review from a team as a code owner November 20, 2026 22:15
@benbrandt
benbrandt enabled auto-merge (squash) November 20, 2026 22:16
@benbrandt
benbrandt merged commit fa50fde into main Nov 20, 2026
15 checks passed
@benbrandt
benbrandt deleted the docs/protocol-nav-order branch November 20, 2026 22:19
@acp-release-bot acp-release-bot Bot mentioned this pull request Nov 20, 2026
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.

1 participant