Skip to content

docs(KOB-55116): update Appium AI docs for new providers and consolidate pages - #686

Open
tiffany-kobiton wants to merge 2 commits into
mainfrom
docs-draft/KOB-55116
Open

tiffany-kobiton wants to merge 2 commits into
mainfrom
docs-draft/KOB-55116

Conversation

@tiffany-kobiton

@tiffany-kobiton tiffany-kobiton commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Updates Appium AI public docs for new providers (Anthropic Claude, Kobiton-hosted LLM) and documents the KOB-54645 breaking change: sessions that set kobiton:llmBaseUrl must now also set kobiton:llmApiKey.
  • Consolidates overview-appium-ai.adoc and user-guide-appium-ai.adoc into one page; relocates the Appium AI capability reference (kobiton:llm*, visionCoordSpace, locatorStrategy) to capabilities/available-capabilities.adoc.
  • Strips all dc.ini / LlmClient / NaturalLanguageLocator references from the three public Appium AI pages per the hard separation rule between public docs and admin content. Public docs now direct users to contact their lab administrator for host-side configuration.

Changes by file

  • overview-appium-ai.adoc — merged in former user-guide content, added updated provider list, Kobiton-hosted LLM exception, KOB-54607 not-found behavior, KOB-54645 troubleshooting bullet.
  • override-llm.adoc — slimmed to a how-to; added Anthropic Claude and Kobiton-hosted LLM examples; capability table + value list moved to the capabilities reference; code fences normalized.
  • user-guide-appium-ai.adoc — deleted (content merged into overview page).
  • available-capabilities.adoc — 10 new Appium AI capability entries inserted alphabetically under the existing "Kobiton Capabilities" h2.
  • nav.adoc — removed user-guide-appium-ai entry (4 Appium AI nav entries → 3).

Test plan

  • Verify overview-appium-ai.adoc renders with 11 h2 sections and the uitree/visionvirtual strategy table
  • Verify override-llm.adoc renders with 5 Python code examples (OpenAI, Azure, Anthropic, Kobiton-hosted, Ollama)
  • Verify the 10 new Appium AI capability entries render on available-capabilities.adoc alphabetically
  • Confirm the Appium AI nav section shows 3 entries (overview, override, extend-custom-locator) with no stale user-guide-appium-ai entry
  • Confirm the AsciiDoc reviewer-note comment on override-llm.adoc is hidden from the rendered Kobiton-hosted LLM section
  • Spot-check: no dc.ini, LlmClient.*, or NaturalLanguageLocator.* strings visible on the rendered Appium AI pages
  • Click through all internal xrefs (merged page → override-llm, override-llm → available-capabilities, override-llm → overview, capability entries → override-llm/overview)

Known open question

The <your-kobiton-llm-key> placeholder in the Kobiton-hosted LLM session example on override-llm.adoc needs engineering confirmation. admin-docs#217 says the dc.ini config falls back to Kobiton.TenantApiKey server-side, but KOB-54645 states server-side keys are not sent to session-specified endpoints. What value a customer passes for a session-level override to the hosted LLM is unresolved. Flagged in-source with an AsciiDoc comment (// REVIEWER NOTE:) above the example for the Vietnam-side technical reviewer. The placeholder is acceptable for now; this is a niche usage pattern (the hosted LLM's primary use is as a host-wide default, which admin-docs covers).

Out of scope

  • Release notes (Cloud and Standalone entries both excluded per prior review).
  • Admin-docs changes (admin-side counterpart tracked under a separate repo/ticket).
  • Cross-repo links to admin-docs (the admin-docs site is password-protected; public docs stay self-contained).

Related: KOB-55116. Reference implementation on the admin side: kobiton/admin-docs#217.

🤖 Generated with Claude Code

…ate pages

- Add Anthropic Claude and Kobiton-hosted LLM provider examples; new
  kobiton:visionCoordSpace capability; new AnthropicMessages,
  KobitonChatCompletions, and OllamaChat API formats.
- Document KOB-54645 breaking change: sessions that set kobiton:llmBaseUrl
  must now also set kobiton:llmApiKey; the default server-side key is not
  forwarded to session-specified endpoints.
- Update default text/vision model from gpt-5.2 to gpt-5.6-terra.
- Consolidate overview + user-guide into a single overview-appium-ai.adoc;
  delete user-guide-appium-ai.adoc; remove its nav entry.
- Move the Appium AI capability reference (kobiton:llm*, visionCoordSpace,
  locatorStrategy) from override-llm.adoc into capabilities/available-capabilities.adoc.
- Strip all dc.ini / LlmClient / NaturalLanguageLocator references from
  the three public Appium AI pages. Direct users to contact their lab
  administrator for host-side configuration.
- Normalize code fences on override-llm.adoc to AsciiDoc [source,python]
  + .python + ---- pattern to match the other pages.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@tiffany-kobiton tiffany-kobiton self-assigned this Oct 5, 2026
@tiffany-kobiton tiffany-kobiton added update existing doc Update of any size made to any existing doc on any platform. ready for review Doc is ready for review labels Oct 5, 2026
Comment thread docs/modules/automation-testing/pages/capabilities/available-capabilities.adoc Outdated
Consolidates kobiton:llm*, kobiton:locatorStrategy, and kobiton:visionCoordSpace
under a discrete "Appium AI capabilities" heading with its own index, so readers
can scan the AI overrides without walking the full alphabetical list.
Addresses Tung's review comment on line 262.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
preview-pr-686 — 04273a51 Deployed Oct 6, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready for review Doc is ready for review update existing doc Update of any size made to any existing doc on any platform.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants