Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions src/content/docs/advanced/browser-extension/connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ title: "Connect to your project"
type: article
---

:::note
Taken from [Browser Extension documentation](https://github.com/testomatio/browser-extension/tree/main/docs/guide/connect.md).
:::


One authorization connects the panel to your account. It then reads each
project's own API key by itself — there is nothing else to find or paste.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ title: "Console & network log (Rec)"
type: article
---

:::note
Taken from [Browser Extension documentation](https://github.com/testomatio/browser-extension/tree/main/docs/guide/console-network-log.md).
:::


The panel records what the tab under test is doing — console messages and
network calls — into a rolling window, and attaches it to a failed result
as a readable text file.
Expand Down
5 changes: 0 additions & 5 deletions src/content/docs/advanced/browser-extension/create-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ title: "Create tests"
type: article
---

:::note
Taken from [Browser Extension documentation](https://github.com/testomatio/browser-extension/tree/main/docs/guide/create-tests.md).
:::


The **Tests** tab browses the project's suites and lets you add test cases
without leaving the panel — by title alone, or written out in the editor.

Expand Down
Binary file not shown.
50 changes: 32 additions & 18 deletions src/content/docs/advanced/browser-extension/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,41 @@ title: "Install and update"
type: article
---

:::note
Taken from [Browser Extension documentation](https://github.com/testomatio/browser-extension/tree/main/docs/guide/install.md).
:::
Install the extension from the Chrome Web Store. Chrome 123 or newer.

## Install

The extension is not in the Chrome Web Store yet. You load it from a folder on
your disk, once, and Chrome keeps it. Chrome 123 or newer.
1. Open [Testomat.io in the Chrome Web Store](https://chromewebstore.google.com/detail/testomatio/amcnjlghmkkjfaajanfeghpgbjakdcka)
and click **Add to Chrome**, then **Add extension**.
2. Click the puzzle icon in Chrome's toolbar and pin **Testomat.io** with the
pushpin:

## Install
![Pinning Testomat.io from the puzzle menu](img/install-pin.png)
3. Click the pinned icon — the panel opens and asks you to connect
(**Connect to Testomat.io**). That is the next page: [Connect](connect.md).

## Update

Chrome updates the extension by itself. Your token, settings and unsent
results survive an update.

## If it didn't work

- **Chrome refuses to add it** — check your Chrome is 123 or newer
(`chrome://settings/help`).

## Install from source

For developers: run the code from this repository instead of the store copy.
The source copy has the same ID as the store copy, so Chrome holds only one of
them: remove the store copy on `chrome://extensions` first. Removing it
deletes its token and settings, so you connect again.

1. Get the folder — either way works:
- download the newest `testomat-io-<version>.zip` from
[Releases](https://github.com/testomatio/browser-extension/releases) —
the single file under **Assets** — and unpack it, **or**
the file under **Assets** without `-webstore` in its name (that one is
the Chrome Web Store upload) — and unpack it, **or**

![The zip under Assets on the Releases page](img/install-release-zip.png)

Expand All @@ -34,18 +55,13 @@ your disk, once, and Chrome keeps it. Chrome 123 or newer.
Either way, the right folder is the one with `manifest.json` directly
inside.

4. Click the puzzle icon in Chrome's toolbar and pin **Testomat.io** with the
pushpin:

![Pinning Testomat.io from the puzzle menu](img/install-pin.png)
5. Click the pinned icon — the panel opens and asks you to connect
(**Connect to Testomat.io**). That is the next page: [Connect](connect.md).
4. Pin the icon and connect, as in steps 2–3 of [Install](#install).

There is nothing to build or install beyond that — the folder runs as is.

## Update
### Update a source copy

There is no auto-update. To get a new version:
A source copy does not update itself. To get a new version:

1. Replace the folder contents: unpack a newer zip over the same folder, or
`git pull` in the clone.
Expand All @@ -56,13 +72,11 @@ There is no auto-update. To get a new version:

Your token, settings and unsent results survive the reload.

## If it didn't work
### If a source copy didn't work

- **"Load unpacked" is missing** — Developer mode is off; the switch is in
the top right corner of `chrome://extensions`.
- **"Manifest file is missing or unreadable"** — you picked the repository
root; pick the `extension/` folder inside it.
- **Chrome refuses to load it** — check your Chrome is 123 or newer
(`chrome://settings/help`).
- **Updated, but behaves like the old version** — press reload (↻) on the
extension's card; replacing the files alone is not enough.
5 changes: 0 additions & 5 deletions src/content/docs/advanced/browser-extension/run-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ title: "Run a manual run"
type: article
---

:::note
Taken from [Browser Extension documentation](https://github.com/testomatio/browser-extension/tree/main/docs/guide/run-tests.md).
:::


You open a run, walk its tests next to the site under test, and mark each
one. Nothing ever navigates on its own — you move on when you choose to.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ title: "Attach a screen recording"
type: article
---

:::note
Taken from [Browser Extension documentation](https://github.com/testomatio/browser-extension/tree/main/docs/guide/screen-recording.md).
:::


The panel records the tab you are testing into a `.webm` — no audio — and
lets you review and trim it before anything uploads.

Expand Down
5 changes: 0 additions & 5 deletions src/content/docs/advanced/browser-extension/screenshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ title: "Attach a screenshot"
type: article
---

:::note
Taken from [Browser Extension documentation](https://github.com/testomatio/browser-extension/tree/main/docs/guide/screenshots.md).
:::


The panel captures the tab you are testing and opens an annotator right
over that page. Nothing uploads until you press **Save** there.

Expand Down
20 changes: 8 additions & 12 deletions src/content/docs/advanced/browser-extension/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ title: "Settings and shortcuts"
type: article
---

:::note
Taken from [Browser Extension documentation](https://github.com/testomatio/browser-extension/tree/main/docs/guide/settings.md).
:::


The **Settings** tab in the panel header holds six folds. **Connection** and
**Failure log** start open; click a heading to unfold the rest. Every
checkbox and field is committed by **Save & validate** at the bottom — it
Expand Down Expand Up @@ -72,16 +67,16 @@ saved.
- **Forget this instance** — deletes the saved token, project and
preferences of the instance the form points at, after a confirmation.
If that is the instance you are on, its restored session, queued results
waiting to be sent, recorded steps, captured log and unsaved drafts go
too, a running recording is stopped, and the panel returns to the connect
screen. Other instances are kept.
waiting to be sent, recorded steps, captured log, screen recording and
unsaved drafts go too, a running recording is stopped, and the panel
returns to the connect screen. Other instances are kept.

## Stored credentials

**Sign out** is for a shared machine: after a confirmation it erases every
saved token, instance, history entry, queued result, session, unsaved test
draft, recorded step and captured log from this browser, stops a running
recording, and reloads the panel onto the connect screen. The colour
draft, recorded step, captured log and screen recording from this browser,
stops a running recording, and reloads the panel onto the connect screen. The colour
scheme and the side-panel-or-window choice stay. Site access is Chrome's
own setting for the extension, on `chrome://extensions`, and is not
touched.
Expand Down Expand Up @@ -132,5 +127,6 @@ From any tab, `Alt+Shift+R` starts or stops a
- **"Nothing saved for …"** — Forget was pressed for a server that was never
saved; nothing was erased.
- **A warning about the recording after Forget or Sign out** — the erase
happened, but the console & network recorder could not be stopped;
restart the browser to be sure its log is gone.
happened, but the console & network recorder or the screen recorder could
not be stopped; the warning names which. Restart the browser to be sure
the log or the video is gone.
11 changes: 6 additions & 5 deletions src/content/docs/advanced/browser-extension/step-recorder.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ title: "Step recorder"
type: article
---

:::note
Taken from [Browser Extension documentation](https://github.com/testomatio/browser-extension/tree/main/docs/guide/step-recorder.md).
:::


Instead of typing steps, do the flow once on the page and let the panel
write it down — as readable Markdown, not code.

Expand Down Expand Up @@ -74,6 +69,12 @@ Testomat.io AI rewrites the recorded steps into cleaner prose. **Undo
polish** puts the recorded wording back. If the AI is unavailable, the
raw steps are kept and the editor says so.

The polish runs on your company's Testomat.io AI. When your company has no
AI features — the plan does not include them, or the company owner has not
switched them on in the company settings — the switch stays off and says
so when you click it, and nothing is sent. On a server with no AI at all,
the switch is not shown.

## If it didn't work

- **Record steps does nothing / says the page can't be recorded** — the
Expand Down
52 changes: 0 additions & 52 deletions src/scripts/runok.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ module.exports = {
await this.docsImporterJava();
await this.importJavaReporterDocs();
await this.importRobotFrameworkReporterDocs();
await this.importBrowserExtensionDocs();
},

async docsImages() {
Expand Down Expand Up @@ -452,57 +451,6 @@ head:
} catch (err) {
console.error(`❌ Failed to fetch robot-framework-reporter README: ${err.message}`);
}
},

async importBrowserExtensionDocs() {
const repoUrl = 'https://github.com/testomatio/browser-extension.git';
const sourceUrl = 'https://github.com/testomatio/browser-extension/tree/main/docs/guide';
const projectFolder = path.resolve(__dirname, '../..');
const checkoutFolder = path.join(projectFolder, 'tmp/browser-extension');
const sourceFolder = path.join(checkoutFolder, 'docs/guide');
const destinationFolder = path.join(projectFolder, 'src/content/docs/advanced/browser-extension');

fs.rmSync(checkoutFolder, { recursive: true, force: true });
execSync(`git clone --depth=1 ${repoUrl} "${checkoutFolder}"`, { stdio: 'inherit' });

if (!fs.existsSync(sourceFolder)) {
throw new Error(`Browser extension documentation was not found at ${sourceFolder}`);
}

// Keep metadata maintained in this repository when upstream content is refreshed.
const fileHeaders = {};
if (fs.existsSync(destinationFolder)) {
const existingFiles = globSync(`${destinationFolder.replace(/\\/g, '/')}/*.md`);
for (const file of existingFiles) {
const content = fs.readFileSync(file, 'utf8');
const match = content.match(/^---[\s\S]+?^---/m);
if (match) fileHeaders[path.basename(file)] = match[0];
}
}

fs.rmSync(destinationFolder, { recursive: true, force: true });
fs.mkdirSync(destinationFolder, { recursive: true });
fs.cpSync(path.join(sourceFolder, 'img'), path.join(destinationFolder, 'img'), { recursive: true });

const markdownFiles = globSync(`${sourceFolder.replace(/\\/g, '/')}/*.md`);
for (const file of markdownFiles) {
let content = fs.readFileSync(file, 'utf8');
const titleMatch = content.match(/^#\s+(.+)$/m);
const title = titleMatch ? titleMatch[1].trim() : humanize(path.basename(file, '.md'));

content = content.replace(/^#\s+.*\r?\n+/, '');

const sourceFileUrl = `${sourceUrl}/${path.basename(file)}`;
const frontMatter = fileHeaders[path.basename(file)] || `---\ntitle: ${JSON.stringify(title)}\ntype: article\n---`;
const sourceNote = `\n\n:::note\nTaken from [Browser Extension documentation](${sourceFileUrl}).\n:::\n\n`;

fs.writeFileSync(
path.join(destinationFolder, path.basename(file)),
frontMatter + sourceNote + content,
);
}

console.log(`Imported ${markdownFiles.length} browser extension documentation pages`);
}
}

Expand Down
Loading