You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs(provider): distinguish source previews from releases - #1763
The provider guide says no release exists. A source-only preview must not be confused with a qualified, installable release.
Fix
Describe preview source archives separately from the provider manifest and supported host claims. Keep installation instructions conditional on native qualification.
Test evidence
Commit: 4c5c219202ab3e2eaf39050fdf9783b0ea63730b. git diff --check: 0 errors. CI: 18 pass, 6 neutral, 9 skipped, 0 failures or pending. The Netlify preview rendered the updated release notice; a browser screenshot was captured. No behavior code changed.
Not verified
Live Docker Sandboxes, native VM qualification, and deployment are not verified. The local mise exec -- prek run --all-files timed out during another worktree's lint run; GitHub's pre-commit job passed.
No actionable comments were generated in the recent review.
Walkthrough
The Docker Sandboxes provider notice now distinguishes source-only previews from installable releases. It states that installation and machine instructions apply only to a natively qualified, published installable release.
Changes: Docker Sandboxes documentation
Layer / File(s)
Summary
Clarify preview and release requirements sites/docs-devsy-sh/content/docs/managing-providers/docker-sandbox.mdx
The notice states that a source-only preview has no installable manifest or supported-host claim. Installation and machine instructions apply only after native qualification and publication of an installable release.
devsy-org/devsy#1753: Both changes document Docker Sandboxes release and host qualification requirements.
devsy-org/devsy#1749: Both changes address the Docker Sandboxes guide’s release and installation contract.
Suggested labels:size/xs, docs-cleanup
Merge Risk: Minimal · up to 4c5c2
The notice clarifies that source-only previews are not installable releases. No merge-blocking risk is identified in this documentation-only change.
Pre-merge checks: 3 · 1
Failed checks: 1 warning
Check name
Status
Explanation
Resolution
Description check
The description states the cause (the provider guide says no release exists, so source-only previews can be confused with installable releases), the fix (preview source archives are described separate…
Complete the template sections the description omits: (1) Add an issue reference line, using 'Fixes #N' or 'Refs #N', or write 'none' if there is no issue. (2) Under 'Type of change', tick 'Docs'. (3) Under 'AI assistance', tick either 'No …
Passed checks: 3 passed
Check name
Status
Explanation
Title check
The title clearly identifies the documentation change: distinguishing provider source previews from installable releases. It is concise and directly related to the main change.
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Description check
Explanation
The description states the cause (the provider guide says no release exists, so source-only previews can be confused with installable releases), the fix (preview source archives are described separately from the provider manifest and supported-host claims, with installation conditional on native qualification), and test evidence (commit hash, git diff --check with 0 errors, CI results, Netlify preview rendering with a screenshot, no behavior code changed). It also has a Not verified section. However, it does not follow the required template: it has no Conventional Commits title in the template form, no 'What and why' heading, no 'Fixes #' or 'Refs #' issue line, no 'Type of change' selection (the change is docs, but it is not ticked), no 'AI assistance' section, no testing checkboxes stating whether an integration test is needed (it should name that docs-only changes need no e2e test), and no checklist items such as lint and CLA confirmation. The core content is solid, but several required template sections are missing.
Resolution
Complete the template sections the description omits: (1) Add an issue reference line, using 'Fixes #N' or 'Refs #N', or write 'none' if there is no issue. (2) Under 'Type of change', tick 'Docs'. (3) Under 'AI assistance', tick either 'No AI tools were used' or 'AI tools were used' and fill in the table, or state that none were used. (4) Under 'Testing', tick 'No integration test needed, because: docs only' and name the reason. (5) Complete the 'Checklist' items that apply, such as confirming the docs under sites/ are updated, that no secrets or personal paths are present, and that the CLA is signed. (6) Remove any template comments and leave no placeholders. (7) Keep the existing 'Not verified' content, and place it under 'Notes for reviewers' if you want a separate section.
Finishing Touches
Simplify code
Commit to this branch
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.
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
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.
Cause
The provider guide says no release exists. A source-only preview must not be confused with a qualified, installable release.
Fix
Describe preview source archives separately from the provider manifest and supported host claims. Keep installation instructions conditional on native qualification.
Test evidence
Commit:
4c5c219202ab3e2eaf39050fdf9783b0ea63730b.git diff --check: 0 errors. CI: 18 pass, 6 neutral, 9 skipped, 0 failures or pending. The Netlify preview rendered the updated release notice; a browser screenshot was captured. No behavior code changed.Not verified
Live Docker Sandboxes, native VM qualification, and deployment are not verified. The local
mise exec -- prek run --all-filestimed out during another worktree's lint run; GitHub's pre-commit job passed.