Skip to content

docs(test-management): add convert automation session page (KOB-54075) - #529

Open
tiffany-kobiton wants to merge 2 commits into
mainfrom
KOB-54075
Open

docs(test-management): add convert automation session page (KOB-54075)#529
tiffany-kobiton wants to merge 2 commits into
mainfrom
KOB-54075

Conversation

@tiffany-kobiton

@tiffany-kobiton tiffany-kobiton commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Summary

New page for the Portal UI flow that converts a completed automation session into a Test Case (feature released 2026-07-06 via KOB-43479). Plus a light companion insertion into the existing Test Cases page pointing readers to the new flow.

  • Adds `docs/modules/test-management/pages/convert-automation-session.adoc` (new page)
  • Adds nav entry directly after `test-cases.adoc`
  • Appends one paragraph to the existing `Convert a session to a Test Case` section in `test-cases.adoc` (does not modify pre-existing prose)

Scope

Documents the UI flow shipped in KOB-43479:

  • Two entry points: Session Explorer, +New Test Case pop-up in the Test Case List
  • Non-convertible session types called out
  • `kobiton:scriptlessCapture` recommendation with the tradeoff
  • Two verbatim toast messages (source-confirmed by dev comment on KOB-43479)
  • Follow-on "open the new Test Case" affordance

Deliberately deferred

  • API coverage: the same convert operation is exposed via the Kobiton API (KOB-43478). API docs live in a separate framework outside public docs. A source-only `// API note:` comment before the See also section explains this so future maintainers see the omission is intentional.
  • `kobiton:scriptlessCapture` reference doc xref: KOB-41142 tracks a separate docs ticket for the capability. Draft references the capability inline in prose; a commented `// TODO:` in See also is ready to uncomment once that doc lands.

Source

Test plan

  • Confirm nav ordering renders correctly (new entry between `test-cases.adoc` and `generate-appium.adoc`)
  • Confirm the companion xref in `test-cases.adoc` renders correctly
  • SME check: exact location of `Convert to Test Case` action inside Session Explorer (row action, menu, panel button?)
  • SME check: confirm the pop-up's action button is labeled `Convert` (inferred from mirrored manual-session flow)
  • SME check: other keyword filters beyond `type:appium` supported in the pop-up
  • SME check: post-conversion landing behavior (auto-navigate to new Test Case, or stay put?)
  • Follow-on tickets to consider:
    • Once KOB-41142 (scriptlessCapture doc) lands, uncomment the See also xref
    • Once the API doc framework is public (or if scope changes), remove the `// API note:` and add an API section here

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Comment thread docs/modules/test-management/pages/convert-automation-session.adoc Outdated
Removed note about API conversion operation and internal reference.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants