-
Notifications
You must be signed in to change notification settings - Fork 159
Consolidate and cleanup Obsearchability AI Assistant page #997
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
* updated "Observability AI Assistant" to "Elastic AI Assistant for Observability and Search", added variable * improved page structure with clear sections and better hierarchy * consolidated privacy information, warnings, and notes into prose sections where possible to avoid admonition fatigue * created provider table for clearer setup options * reorganized knowledge base section with recommended approaches first * reorganized embedding methods to prioritize simpler approach * added clear navigation paths throughout document * reorganized functions as subcategory of chat rather than separate feature * improved section organization to match user workflow * rephrased LLM limitations warning for clarity * add quickstart guide at top for basic setup * breakout information onto separate pages
I think the refinement and improvements are good and beneficial here @leemthompo , thanks! My comments for this or a next PR are:
That's the only thing that looks a bit weird in my opinion. The long doc itself looks good. Final comment: What if we try to put AI Assistant as a Level 1 citizen on the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Added some comments as the short doc in search feels a bit weird and not correctly presented or scoped.
Thanks for review @eedugon!
💯 it's basically a soft redirect for visibility of AI Assistant functionality in search spaces, I can trim it down fully right now and just make it a link to the consolidated doc.
Yup but it's too big to snippet and way too big to duplicate for SEO reasons. This first cut is really just trying to simplify the big existing doc. Otherwise, I think it's now much easier to reason about splitting that page into multiple subsections 👍
Yeah that might be an idea, I'm still not sure how feasible it will be to factor out shared stuff for Security + Obs/Search assistants, because security seems to be meaningfully different. It's basically a confusing subject, because on top of this a lot of the core functionality is changing rapidly too, hence why the original Obs doc has gotten so long 😄 |
I'll create a follow up ticket for splitting the big page up |
clarified llm connector is in ech deployments and serverless reorganized requirements section reformatted data usage info as definition list moved accuracy warning to more relevant section cut search ai page down to the bone
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, LGTM!
closes https://github.com/elastic/search-docs-team/issues/237
👁️ > 👁️ URL preview
Summary
Follow up ideas