Add Agent Builder glossary#6175
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
🔍 Preview links for changed docs |
Vale Linting ResultsSummary: 1 warning, 1 suggestion found
|
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/ai-features/agent-builder/glossary.md | 223 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'versus' instead of 'VS'. |
💡 Suggestions (1)
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/ai-features/agent-builder/glossary.md | 49 | Elastic.Semicolons | Use semicolons judiciously. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
There was a problem hiding this comment.
Docs review summary
Focus areas
- Style and clarity: Two issues — a subjectless sentence fragment in the A2A server definition (line 31) and "LLM" used without expansion on first use (line 34). All other entries are clear and well-structured.
- Jargon: "GenAI" appears throughout as the Kibana feature name (GenAI connector, GenAI Settings), which is acceptable as it matches the product UI. All other acronyms used in definition terms (RAG, MCP, A2A) are expanded within their own entries.
- Frontmatter and
applies_to: Frontmatter is present and complete —applies_to,products,description, andnavigation_titleall pass. Inlineapplies_tobadges are used extensively; two placement issues flagged inline (lines 46 and 234) where badges precede rather than follow the content they scope. - Content type fit: Glossary is not one of the five standard Elastic content types (overview, how-to, tutorial, troubleshooting, changelog), so no
typefield is expected or required. Structure and formatting are appropriate for a reference glossary. - Parent issue satisfaction: Closes elastic/docs-content-internal#1059 (private). Based on the PR description, the ask was a terminology glossary for Agent Builder docs. The page covers the feature comprehensively and alphabetically with version badges — appears satisfied.
Nits
description(line 3): Starts with a noun phrase ("Definitions of the key terms...") rather than a verb. Suggest:"Defines the key terms used throughout the Elastic Agent Builder documentation."— a minor style-guide-based preference.
Notes
- Vale is not installed in this environment; manual review was performed against the Elastic style guide rules.
- The
toc.ymlchange is out of scope for this markdown review.
Docs automation | From workflow: Docs review agent
React with 👍 if helpful, 👎 if not.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
|
Thank you @akm-esco for the review 🙂 |
pgayvallet
left a comment
There was a problem hiding this comment.
(Feel free to ignore part or all of the comments)
| GenAI Settings {applies_to}`stack: ga 9.4+` | ||
| : The {{kib}} settings page where you configure the default model and other generative-AI options that affect {{agent-builder}}. See [Models](models.md). | ||
|
|
||
| ## I |
There was a problem hiding this comment.
An entry for Inference endpoint (which are "replacing" AI connectors we're deprecating) maybe?
There was a problem hiding this comment.
Looked into this: the term isn't actually used in the AB docs yet. It only appears in mcp-server.md as a cluster-privilege footnote, and models.md/connectors.md still speak in connectors. Per the glossary's scope ("terms used throughout the AB documentation"), I'd hold off until those pages are rewritten around the AI Connector / inference endpoint model. Happy to add it then. What do you think?
There was a problem hiding this comment.
I'd hold off until those pages are rewritten around the AI Connector / inference endpoint model
@charlotte-hoblik can you create a ticket for that and assign it to yourself for this new sprint
you can chat to Lisa about this, as she worked on the ES solution updates around inference endpoints :)
| Slash command {applies_to}`stack: ga 9.4+` | ||
| : The chat shortcut for explicitly invoking a skill. Type `/` followed by the skill name to bypass automatic skill selection. See [Skills](skills.md). |
There was a problem hiding this comment.
Is that the naming we ended up with? At some point we were naming those "Chat commands"
There was a problem hiding this comment.
Good question. I went and double-checked the docs. "Slash command" is the term in use inskills.md
|
Thank you for the review @pgayvallet 🙂 |
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Adds a new
glossary.mdpage underexplore-analyze/ai-features/agent-builder/covering the terminology used across the Agent Builder docs. Entries are alphabetical, in definition-list format, with inlineapplies_tobadges for terms scoped to specific versions.URL preview: https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/6175/explore-analyze/ai-features/agent-builder/glossary
Closes https://github.com/elastic/docs-content-internal/issues/1059
Generative AI disclosure
Tool(s) and model(s) used:
Opus 4.7