Testplane-quickstart by Nikolaengel · Pull Request #114 · gemini-testing/testplane-docs

Nikolaengel · 2026-01-29T12:31:55Z

Pull request for quick start

…lectors.mdx

i18n/ru/docusaurus-plugin-content-docs/current/quickstart/running-tests.mdx

i18n/ru/docusaurus-plugin-content-docs/current/quickstart/index.mdx

i18n/ru/docusaurus-plugin-content-docs/current/quickstart/running-tests.mdx

i18n/ru/docusaurus-plugin-content-docs/current/quickstart/writing-tests.mdx

…/testplane-docs into testplane-quickstart

shadowusr

В целом получилось прикольно, мне понравилось!

Что нужно доделать, чтобы это можно было влить и опубликовать:

поправить несколько минорных замечаний, особенно про скриншот старого дизайна
починить ошибки линтеров — можно увидеть их, запустив npm test, форматирование можно авто-поправить с помощью команды npm run reformat
добавить версии статей на английском, т.к. без этого эти статьи не будут отображаться на сайте, нужно выкатывать сразу в 2 вариантах

shadowusr · 2026-02-19T08:24:25Z

static/img/docs/guides/testplane-gui.png

Думаю, лучше использовать скриншоты из New UI, так как именно новый интерфейс является актуальным. Для этого нужно нажать на кнопку Try New UI

shadowusr · 2026-02-19T08:25:42Z

i18n/ru/docusaurus-plugin-content-docs/current/quickstart/index.mdx

+
+## Установка {#install}
+
+Для запуска установщика testplane, с помощью `npm` выполните следующую команду:


тут лишняя запятая

shadowusr · 2026-02-19T08:27:19Z

i18n/ru/docusaurus-plugin-content-docs/current/quickstart/running-tests.mdx

+```javascript
+const assert = require("assert");
+
+describe("tests", () => {


Тут пример можно сократить до двух тестов (двух конструкций it), будет меньше текста, читать легче

shadowusr · 2026-02-19T08:28:44Z

i18n/ru/docusaurus-plugin-content-docs/current/quickstart/writing-tests.mdx

+        const searchButton = await browser.$("button.DocSearch");
+        await searchButton.waitForClickable({timeout: 5000});
+        await searchButton.click();
+        await browser.pause(1000);


Нужно убрать browser.pause из всех примеров, это плохая практика

shadowusr · 2026-02-19T08:33:55Z

i18n/ru/docusaurus-plugin-content-docs/current/quickstart/writing-tests.mdx

+        assert.strictEqual(inputValue, "browser");
+    });
+
+    it("Пример двойного клика — выделение текста заголовка", async ({browser}) => {


В этом примере было бы прикольнее, наверное, разбить на секции — "Взаимодействие с кнопками и клики", "Заполнение форм", и т.д. В эту же секцию я бы перенес раздел про работу с формами, т.к. это тоже про взаимодействие с элементами

shadowusr · 2026-02-19T08:38:15Z

i18n/ru/docusaurus-plugin-content-docs/current/quickstart/writing-tests.mdx

+describe("Примеры работы с хуками", () => {
+    // beforeEach — выполняется перед каждым тестом
+    beforeEach(async ({ browser }) => {
+        console.log("--- Выполняется BEFOREEACH — перед каждым тестом ---");
+        await browser.url("https://testplane.io/ru/");
+        await browser.pause(500);
+    });
+
+    // afterEach — выполняется после каждого теста
+    afterEach(async ({ browser }) => {
+        console.log("--- Выполняется AFTEREACH — после каждого теста ---");
+        const currentUrl = await browser.getUrl();
+        console.log("Текущий URL:", currentUrl);
+        // Можно делать скриншоты, очищать данные и т.д.
+    });
+
+    it("Тест 1 — проверка заголовка", async ({ browser }) => {
+        const title = await browser.getTitle();
+        assert.ok(title.includes("Testplane"));
+    });
+
+    it("Тест 2 — проверка логотипа", async ({ browser }) => {
+        const logo = await browser.$("a.navbar__brand");
+        const isDisplayed = await logo.isDisplayed();
+        assert.strictEqual(isDisplayed, true);
+    });
+
+    it("Тест 3 — проверка поиска", async ({ browser }) => {
+        const searchButton = await browser.$("button.DocSearch");
+        const isExisting = await searchButton.isExisting();
+        assert.strictEqual(isExisting, true);
+    });
+});


Думаю это можно удалить, так как пример с вложенностью ниже покрывает сразу все кейсы.

shadowusr

Нужно точно поправить проблему с бэктиками

shadowusr · 2026-02-27T11:19:17Z

docs/quickstart/index.mdx

+import Admonition from "@theme/Admonition";

-# Installation {#install}
+# Installation and setup


Installation and Setup, такой формат указан в гайдлайнах, английские заголовки самого верхнего уровня — каждой слово с большой буквы, кроме предлогов

shadowusr · 2026-02-27T11:21:20Z

docs/quickstart/running-tests.mdx

 ---

-# Running Tests
+# Running and debugging


Running and Debugging Tests

shadowusr · 2026-02-27T11:24:59Z

docs/quickstart/running-tests.mdx

+
+### Running a specific test
+
+You have a set of tests and need to run just one of them.


Consider the following set of tests:

...

If you want to run just one of them, use --grep option:

shadowusr · 2026-02-27T11:33:05Z

docs/quickstart/running-tests.mdx

 ```

-## The `--grep` Option {#the_grep_option}
+In the quotes, you need to pass the content of the parentheses in the `it` keyword.


Это не обязательно содержимое it целиком. Лучше написать так: You can pass the whole test name, some part of it or regex pattern to run only those tests whose names will match..

shadowusr · 2026-02-27T11:34:24Z

docs/quickstart/writing-tests.mdx

+
+The `describe` block is used to group related tests.
+
+````javascript


Тут есть проблема с синтаксисом: слишком много бэктиков, и они не закрыты.

Nikolaengel added 16 commits December 29, 2025 21:23

docs: selectors

e939f68

docs-updatequickstart

a6742e8

docs: selectors-fix

f9688e7

docs: fix-prettier

9a06f74

docs: tabs-fix

90cfc1c

docs: fix-quickstart

f109786

docs: quickstart-fix

ec6296b

docs: writingtests-fix

bd295dd

docs: runningtests-fix

f12bc41

docs: selectors

9246463

docs: runningtests-fix

c5b9411

docs: margins-fix

7f4f18d

docs:screenshot-fix

66416c2

docs: quickstart-fix

3918e64

Delete docs/basic-guides/selectors.mdx

e5655f4

Delete i18n/ru/docusaurus-plugin-content-docs/current/basic-guides/se…

e63e6f6

…lectors.mdx