elastic / elastic/docs-content

Docs fix — style: path /explore-analyze/ai-features — 75 pages

Open
#6,439 0 comments 0 reactions 0 assignees View on GitHub
docs-fix:style docs-quality-sweep
Dominant language
No language data
Stars
47
Forks
261
Avg merge
3d 12h
Merged PRs (30d)
116

Description

Generated by `gh-aw-docs-style-sweep` for `elastic/docs-content` on 2026-W20.

Path /explore-analyze/ai-features · 75 total in scope · subtree corpus 75 pages.

## Findings (25)

```yaml
- file: explore-analyze/ai-features/llm-guides/connect-to-azure-openai.md
line: 42
category: accessibility
severity: medium
evidence: "'Click here' — Elastic.MeaningfulCTAs: non-descriptive link text"
suggested_fix: |
Replace "Click here" with descriptive text, e.g. "For details, visit the Azure OpenAI documentation"

- file: explore-analyze/ai-features/llm-guides/connect-to-azure-openai.md
line: 57
category: grammar
severity: medium
evidence: "'\"Auto-update to default\".' — Elastic.QuotesPunctuation: period outside closing quote"
suggested_fix: |
"Auto-update to default."

- file: explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md
line: 48
category: word-choice
severity: medium
evidence: "'just' — Elastic.DontUse: banned term"
suggested_fix: |
Remove "just"

- file: explore-analyze/ai-features/ai-chat-experiences/ai-assistant.md
line: 48
category: grammar
severity: medium
evidence: "'\"Provide comments explaining the query you just gave\".' — Elastic.QuotesPunctuation: period outside closing quote"
suggested_fix: |
"Provide comments explaining the query you just gave."

- file: explore-analyze/ai-features/agent-builder/agent-builder-api-tutorial.md
line: 218
category: formatting
severity: medium
evidence: "heading ends with '.' — Elastic.EndPuntuaction: no punctuation at end of headings"
suggested_fix: |
Remove trailing period from heading

- file: explore-analyze/ai-features/agent-builder/agent-builder-api-tutorial.md
line: 626
category: formatting
severity: medium
evidence: "heading ends with '.' — Elastic.EndPuntuaction: no punctuation at end of headings"
suggested_fix: |
Remove trailing period from heading

- file: explore-analyze/ai-features/agent-builder/agent-builder-dashboards-and-visualizations.md
line: 60
category: accessibility
severity: medium
evidence: "'on the left' and 'on the right' — Elastic.DirectionalLanguage: avoid directional cues"
suggested_fix: |
Replace with the label of the UI element (e.g., "the Metrics panel")

- file: explore-analyze/ai-features/agent-builder/connectors.md
line: 41
category: ui-writing
severity: medium
evidence: "'**Manage components** > **Connectors**' — Elastic.MenuArrowsBold: use → not >"
suggested_fix: |
Select **Manage components** → **Connectors**

- file: explore-analyze/ai-features/agent-builder/custom-skills.md
line: 41
category: ui-writing
severity: medium
evidence: "'**Manage components > Skills**' — Elastic.MenuArrowsBold: use → not >"
suggested_fix: |
Go to **Manage components** → **Skills**, then select **Create a skill**.

- file: explore-analyze/ai-features/agent-builder/glossary.md
line: 223
category: grammar
severity: medium
evidence: "'VS' — Elastic.Latinisms: use full English word"
suggested_fix: |
versus

- file: explore-analyze/ai-features/agent-builder/mcp-server.md
line: 3
category: grammar
severity: medium
evidence: "'VS' — Elastic.Latinisms: use full English word"
suggested_fix: |
versus

- file: explore-analyze/ai-features/agent-builder/mcp-server.md
line: 42
category: grammar
severity: medium
evidence: "'VS' and 'etc' — Elastic.Latinisms: avoid Latin abbreviations"
suggested_fix: |
Replace "VS" with "versus" and "etc" with "and so on"

- file: explore-analyze/ai-features/agent-builder/permissions.md
line: 97
category: formatting
severity: medium
evidence: "heading ends with '.' — Elastic.EndPuntuaction: no punctuation at end of headings"
suggested_fix: |
Remove trailing period from heading

- file: explore-analyze/ai-features/agent-builder/plugins.md
line: 29
category: ui-writing
severity: medium
evidence: "'**Manage components** > **Plugins**' — Elastic.MenuArrowsBold: use → not >"
suggested_fix: |
Select **Manage components** → **Plugins**

- file: explore-analyze/ai-features/agent-builder/skill-creation-guidelines.md
line: 98
category: accessibility
severity: medium
evidence: "'in the right' — Elastic.DirectionalLanguage: avoid directional cues"
suggested_fix: |
Replace with the label of the UI element

- file: explore-analyze/ai-features/agent-builder/tools.md
line: 17
category: formatting
severity: medium
evidence: "heading ends with '.' — Elastic.EndPuntuaction: no punctuation at end of headings"
suggested_fix: |
Remove trailing period from heading

- file: explore-analyze/ai-features/agent-builder/tools/custom-tools.md
line: 110
category: accessibility
severity: medium
evidence: "'in the left' — Elastic.DirectionalLanguage: avoid directional cues"
suggested_fix: |
Replace with the label of the UI element

- file: explore-analyze/ai-features/agent-builder/tools/workflow-tools.md
line: 46
category: ui-writing
severity: medium
evidence: "'Agents > More' and 'tools > New' — Elastic.MenuArrows: use → not >"
suggested_fix: |
Agents → More ... tools → New

- file: explore-analyze/ai-features/agent-builder/tools/workflow-tools.md
line: 95
category: accessibility
severity: medium
evidence: "'in the left' — Elastic.DirectionalLanguage: avoid directional cues"
suggested_fix: |
Replace with the label of the UI element

- file: explore-analyze/ai-features/agent-builder/tools/workflow-tools.md
line: 105
category: ui-writing
severity: medium
evidence: "'More > Edit' — Elastic.MenuArrows: use → not >"
suggested_fix: |
More → Edit

- file: explore-analyze/ai-features/llm-guides/connect-to-vLLM.md
line: 15
category: accessibility
severity: medium
evidence: "'The steps below' — Elastic.DirectionalLanguage: avoid directional cues"
suggested_fix: |
The following steps

- file: explore-analyze/ai-features/llm-guides/connect-to-vLLM.md
line: 47
category: ui-writing
severity: medium
evidence: "'Settings > Access' — Elastic.MenuArrows: use → not >"
suggested_fix: |
Settings → Access

- file: explore-analyze/ai-features/agent-builder/models.md
line: 125
category: word-choice
severity: low
evidence: "'or older' — Elastic.Versions: use preferred version range wording"
suggested_fix: |
or earlier

- file: explore-analyze/ai-features/llm-guides/connect-to-lmstudio-security.md
line: 148
category: formatting
severity: low
evidence: "': l' — Elastic.HeadingColons: capitalize first word after colon in heading"
suggested_fix: |
Capitalize the word following the colon in the heading

- file: explore-analyze/ai-features/llm-guides/connect-to-lmstudio-observability.md
line: 94
category: word-choice
severity: low
evidence: "'or higher' — Elastic.Versions: use preferred version range wording"
suggested_fix: |
or later
```

## Done when
- All listed lines pass the Elastic style guide rules cited.
- A PR addressing this issue is merged.

## Notes
- Low-severity single-word `WordChoice` findings (may, execute, clone, launch, easy) are pervasive across the subtree; they are omitted here as candidates for a bulk automated fix.

> Generated by [Docs style sweep agent](https://github.com/elastic/docs-content/actions/runs/25733945199/agentic_workflow) · ● 641.1K · [◷](https://github.com/search?q=repo%3Aelastic%2Fdocs-content+is%3Aissue+%22gh-aw-workflow-call-id%3A+elastic%2Fdocs-content%2Fgh-aw-docs-style-sweep%22&type=issues)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.