feat(docs): experimental gate for search/ask, positional args, remove chat#457
Open
Mpdreamz wants to merge 2 commits into
Open
feat(docs): experimental gate for search/ask, positional args, remove chat#457Mpdreamz wants to merge 2 commits into
Mpdreamz wants to merge 2 commits into
Conversation
…, add positional args - Remove `docs chat` from the registered command group (chat.ts retained but unexposed) to reserve the right to remove or redesign multi-turn interaction after assessing real usage patterns post-release - Add --accept-experimental flag to `docs search` and `docs ask`; without it a yellow two-line banner warns the commands are experimental and not yet suited for automation — motivation is to preserve the option to retire or reshape them (e.g. drop `ask` after measuring load) without breaking users who relied on them in scripts - Accept the primary argument (query / question / path) as a positional arg so `elastic docs search "Query DSL"` works naturally alongside the flag forms - Yellow ANSI colour on the banner when stderr is a TTY; plain text when piped Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Reflects removal of docs chat, --accept-experimental on docs search/ask, and positional args on docs search/ask/read. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
🔍 Preview links for changed docs⏳ Building and deploying preview... View progress This comment will be updated with preview links when the build is complete. |
2 tasks
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
docs chatfrom the registered command group to reserve the right to remove or redesign multi-turn interaction after assessing real usage post-release. The file is retained but unexposed.--accept-experimentalflag todocs searchanddocs ask. Without it, a yellow two-line banner warns the commands are experimental and not yet suited for automation. Motivation: preserve the option to retire or reshape commands (e.g. dropaskafter measuring load) without breaking users who relied on them in scripts.search,ask, andreadsoelastic docs search "Query DSL"works naturally alongside the existing--query/--question/--pathflag forms.cc @elastic/docs-engineering
Demo
Test plan
elastic docs search "Query DSL" --size 1— shows yellow experimental banner, returns resultselastic docs search "Query DSL" --size 1 --accept-experimental— no bannerelastic docs ask "what is an index?"— shows yellow experimental bannerelastic docs read /reference/elasticsearch— no banner (not experimental-gated)elastic docs chat— command not found (removed from group)elastic docs search --query "Query DSL"— flag form still workselastic docs search "x" | cat) — banner is plain text, no ANSI codes--jsonflag — no banner emittednpm run test:unit🤖 Generated with Claude Code