docs(ai): add active-development caution callout to AI pages#66
Open
tmgbedu wants to merge 1 commit into
Open
Conversation
Add a prominent warning admonition near the top of every AI docs page (agent, image, audio, mcp, skills) noting the AI package is under active development, that APIs may change without notice, and that it should be used with caution in production while we experiment with the best integration patterns.
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
1 participant
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.
Summary
Adds a prominent caution callout near the top of every AI documentation page, stating the AI package is under active development, may introduce breaking changes, and that the team is still experimenting with the best integration approach. Documentation-only. (task #1235)
Pages updated
A VitePress
::: warningadmonition (matching the style already used elsewhere in the docs) was inserted right after the H1 on:docs/ai/agent.mddocs/ai/image.mddocs/ai/audio.mddocs/ai/mcp.mddocs/ai/skills.mdWording:
Applied to all five pages so the notice is visible regardless of which AI page a reader lands on.
The companion source-package docstring warning is in a separate PR against the framework repo.