Add documentation suggestion automation#49194
Merged
morgankrey merged 6 commits intomainfrom Feb 18, 2026
Merged
Conversation
Scripts and workflow for automatically suggesting documentation updates when PRs modify user-facing code. Scripts: - script/docs-suggest: Analyze PRs/commits for documentation needs - script/docs-suggest-publish: Create PR from batched suggestions - script/docs-strip-preview-callouts: Remove callouts for stable release - script/test-docs-suggest-batch: Testing utility Workflow (.github/workflows/docs_suggestions.yml): - PRs to main: Batch suggestions to docs/suggestions-pending branch - Cherry-picks to release branches: Post suggestions as PR comments Callout types: - Additive features: > **Preview:** This feature is available in Zed Preview. - Behavior changes: > **Changed in Preview (vX.XXX).** See [release notes]... Both callout types are stripped when features ship to stable. Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Stop masking docs-suggest workflow failures so broken analysis is visible, and document both additive and behavior-change callout types in docs-suggest-publish. Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
Require rubric-scored full-file brand review in docs suggestions and convert preview publish into a one-command auto-apply flow that opens a draft PR for human approval. Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
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.
Adds scripts and a GitHub Action workflow for automatically suggesting documentation updates when PRs modify user-facing code.
Scripts
script/docs-suggest: Analyze PRs/commits for documentation needs using AIscript/docs-suggest-publish: Create a PR from batched suggestionsscript/docs-strip-preview-callouts: Remove Preview callouts when shipping to stablescript/test-docs-suggest-batch: Testing utility for batch analysisWorkflow
The GitHub Action (
.github/workflows/docs_suggestions.yml) handles two scenarios:docs/suggestions-pendingbranch for the next Preview releaseCallout Types
The system distinguishes between:
Additive features (new commands, settings, UI):
> **Preview:** This feature is available in Zed Preview. It will be included in the next Stable release.Behavior modifications (changed defaults, altered existing behavior):
> **Changed in Preview (v0.XXX).** See [release notes](/releases#0.XXX).Both callout types are stripped by
docs-strip-preview-calloutswhen features ship to stable.Example Output
See PR #49190 for example documentation suggestions generated by running this on PRs from the v0.224 preview window.
Usage
Release Notes: