Skip to content

Add documentation suggestion automation#49194

Merged
morgankrey merged 6 commits intomainfrom
docs-automation-workflow
Feb 18, 2026
Merged

Add documentation suggestion automation#49194
morgankrey merged 6 commits intomainfrom
docs-automation-workflow

Conversation

@morgankrey
Copy link
Copy Markdown
Contributor

@morgankrey morgankrey commented Feb 14, 2026

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 AI
  • script/docs-suggest-publish: Create a PR from batched suggestions
  • script/docs-strip-preview-callouts: Remove Preview callouts when shipping to stable
  • script/test-docs-suggest-batch: Testing utility for batch analysis

Workflow

The GitHub Action (.github/workflows/docs_suggestions.yml) handles two scenarios:

  1. PRs merged to main: Suggestions are batched to docs/suggestions-pending branch for the next Preview release
  2. Cherry-picks to release branches: Suggestions are posted as PR comments for immediate review

Callout 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-callouts when 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

# Analyze a PR (auto-detects batch vs immediate mode)
script/docs-suggest --pr 49100

# Dry run to see assembled context
script/docs-suggest --pr 49100 --dry-run

# Create PR from batched suggestions
script/docs-suggest-publish

# Strip callouts for stable release
script/docs-strip-preview-callouts

Release Notes:

  • N/A

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>
@cla-bot cla-bot bot added the cla-signed The user has signed the Contributor License Agreement label Feb 14, 2026
@zed-community-bot zed-community-bot bot added the staff Pull requests authored by a current member of Zed staff label Feb 14, 2026
morgankrey and others added 5 commits February 14, 2026 15:36
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>
@morgankrey morgankrey marked this pull request as ready for review February 18, 2026 03:19
@morgankrey morgankrey requested review from a team as code owners February 18, 2026 03:19
@maxdeviant maxdeviant changed the title feat: Add documentation suggestion automation Add documentation suggestion automation Feb 18, 2026
@morgankrey morgankrey merged commit dc41f71 into main Feb 18, 2026
29 checks passed
@morgankrey morgankrey deleted the docs-automation-workflow branch February 18, 2026 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cla-signed The user has signed the Contributor License Agreement staff Pull requests authored by a current member of Zed staff

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant