docs: note that analyze, parse and fmt are in beta - #4588
Merged
Conversation
Add a GitHub alert at the top of each command's page so readers know the flags and output are still subject to change, and that fmt rewrites query files in place. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DnqiFw1XAw6b14bSf1GQZb
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.
Adds a beta notice to the top of the three command pages so readers know these commands aren't stable yet.
Each notice sits directly under the page title and uses the
> [!NOTE]GitHub alert style already used elsewhere in the docs (docs/howto/push.md,docs/howto/overrides.md) —internal/docs/lint.gorequires GitHub alerts rather than MyST directives.docs/howto/analyze.md— flags and JSON output may change, and the types it reports can differ from whatgenerateproducesdocs/howto/parse.md— flags and the shape of the printed JSON AST may changedocs/howto/fmt.md— the formatting it produces may change, plus a reminder that it rewrites query files in placeDocs only; no code changes.
go test ./internal/docs/...passes.Generated by Claude Code