#webmate #first steps #documentation

Use the webmate Documentation

The webmate documentation is organized by task. Start with the section that matches what you want to do, then use search and the related links inside each article to move to the next step.

Choose the Right Section

Use the main navigation to choose the area that matches your workflow:

  • First Steps helps you find the most important entry points for a new account or trial.
  • Web Testing covers Selenium-based browser testing on desktop and mobile devices.
  • App Testing covers Appium-based testing for Android and iOS apps.
  • Interactive Testing covers manual testing with webmate devices and the Workbench.
  • Visual Testing covers visual comparisons and layout regression testing.
  • Test Management covers test lab workflows, test runs, reports, and organization.
  • API and SDKs covers webmate APIs, SDK examples, and automation endpoints.
  • webmate Administration covers projects, users, roles, settings, integrations, and infrastructure.
  • Support explains how to contact webmate support and use the ticketing system.

If you are not sure where to start, use the getting-started article for the workflow you want to try first: Web Testing for browser automation or App Testing for mobile app automation.

Use Article Types

Articles use categories to show what kind of page you are reading:

  • tutorial articles guide you through a larger workflow from start to finish.
  • how-to articles solve a specific task.
  • reference articles collect facts, settings, capabilities, API details, or available options.
  • release notes describe changes in a specific webmate release.

When you want to learn a workflow, start with a tutorial. When you already know what to do and need one command, option, or setting, use a how-to or reference article.

Search for Specific Terms

Use search when you know the feature, setting, or capability name. Search terms such as Selenium capabilities, Mobile Access, API key, Jira integration, or device cleanup usually lead directly to the relevant article.

If a search result is too broad, add the workflow area to the term. For example, search for Appium capabilities instead of only capabilities.

Choose Code Examples

Many automation articles include code examples. When an article offers language tabs, choose the language that matches your test project, for example Java or TypeScript. The selected language is used for the code examples on pages that support language-specific snippets.

For automation setup, start with:

Follow Cross-Links

Most articles link to prerequisite or follow-up pages. Use these links when an article mentions a feature that needs separate setup, such as API keys, device slots, project roles, integrations, or support requests.

Reference pages often link to tutorials or how-to articles that show the same concept in context. Tutorials often link back to reference pages when you need the full list of options.

Get Help

If the documentation does not answer your question, use the Support section. The webmate Ticketing System article explains how to create and manage tickets.

When you contact support, include the article URL, the webmate project if relevant, the device or test run if relevant, and what you expected to happen. This helps support connect your question to the right product area quickly.