docs: [EXPERIMENT] Documentation suggestions for v0.224 preview#49190
Closed
morgankrey wants to merge 2 commits intomainfrom
Closed
docs: [EXPERIMENT] Documentation suggestions for v0.224 preview#49190morgankrey wants to merge 2 commits intomainfrom
morgankrey wants to merge 2 commits intomainfrom
Conversation
cla-bot
bot
added
the
cla-signed
zed-community-bot
bot
added
the
staff
Contributor
morgankrey
force-pushed
the
docs/suggestions-v0.224-experiment
branch
4 times, most recently
from
cc1fd07 to
a02114f
Compare
Example output showing what the docs-suggest automation would generate for the v0.224 preview release. PRs analyzed: - #48118: Forward ZED_ env vars to flatpak (no docs needed) - #48467: Move update button to title bar (docs needed) - #48553: Tool permissions refactor (docs exist, wrong format) - #48592: vim :bdelete command (docs needed) - #48814: Devcontainer root support (docs needed) - #48912: Split diff default (docs needed) 5 of 6 PRs generated actionable suggestions. Files: - docs/.suggestions/v0.224-suggestions.md: Raw suggestion output - docs/src/update.md: Update notification UI documentation - docs/src/vim.md: Added :bdelete command - docs/src/dev-containers.md: Root config file location support Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com>
morgankrey
force-pushed
the
docs/suggestions-v0.224-experiment
branch
from
c0f4f2c to
df8db23
Compare
morgankrey
added a commit
that referenced
this pull request
Feb 18, 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): ```markdown > **Preview:** This feature is available in Zed Preview. It will be included in the next Stable release. ``` - **Behavior modifications** (changed defaults, altered existing behavior): ```markdown > **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 ```bash # 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
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
2 participants
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.
Documentation Suggestions Experiment
This PR demonstrates what the
docs-suggestworkflow would have generated for the v0.224 preview release.What This Is
A simulated run of the documentation automation system against 6 user-facing PRs that went into v0.224 preview (Feb 5-12, 2026).
Results
5 of 6 PRs generated actionable suggestions.
How to Review
docs/.suggestions/v0.224-preview-suggestions.mdThis is NOT meant to be merged
This PR is for review/feedback on the suggestion quality only. Close without merging.
See the full suggestions in the file diff.