docs: document kits v3 and preserve v2 - #26065
Draft
dvdksn wants to merge 6 commits into
Draft
Conversation
The kit documentation described v2 runtime customizations and a v1 agent walkthrough, without the v3 workload, build, or capability contracts. Make v3 the primary guide, schema reference, and examples, retain the v2 pages in a separate section, and align navigation and credential guidance. Co-authored-by: Codex <noreply@openai.com>
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Replace the outdated Mistral Vibe launch syntax and explain positional local, OCI, and Git workload references. Keep mixin usage distinct and point v2 examples at the matching documentation.
The draft introduced build requirements and schema mechanics before showing what a kit contains or how to run one. Lead with source files and a runnable workload, explain capabilities through examples, and defer composition and build rules. Order mixin examples by complexity, develop the agent descriptor step by step, move migration guidance after the reference, and preserve the signing anchor used by the homepage.
The introductory shell workload gave readers little reason to use kits, while shared concepts remained in the preserved v2 guide. Use OpenCode with Ruff and review instructions for the introductory workload. Bring use cases, agent guidance, settings, environment configuration, debugging, and a skill example into v3, and focus v2 pages on their schema and behavior.
The Run a kit section continued the OpenCode example and mixed basic usage with credentials, source formats, composition, and sandbox reuse. Lead with general run syntax and group sources, mixins, and naming into dedicated subsections. Keep credential setup in the authentication section and remove agent-specific tutorial steps from usage guidance.
Several guide sections assumed readers had followed the OpenCode example, and individual recipes depended on an unlinked sample workload. Lead topics with their concepts, link supporting examples and recipe prerequisites, and point reference readers to specific guide sections. Group registry publishing and Git sharing by task and keep launch syntax in the usage section.
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.
Description
The kit documentation describes v2 runtime customization, while v3 introduces buildable workload and mixin images with typed runtime capabilities. Make v3 the primary documentation path and preserve the v2 guide, examples, and reference in a separate section without marking earlier formats deprecated.
Validated kit image builds, binary smoke checks, descriptor samples against the schema implementation, scoped Markdown and style lint, a full Hugo build, and internal links. Full authenticated sbx launches remain untested.
@netlify /ai/sandboxes/customize/kits/
Generated by Codex