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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file modified src/content/docs/advanced/living-doc/images/embed_suite.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
68 changes: 32 additions & 36 deletions src/content/docs/advanced/living-doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ head:
content: Living Documentation, Testomat.io, dynamic documentation, test management, Jira integration, test suites, embedding tests, iframe, real-time documentation, Confluence integration
---

Living Documentation is a dynamic, always-up-to-date view of your tests, test suites and system behavior. Instead of relying on static documents that quickly become outdated, teams can use Living Documentation to share **test coverage, scenario details, and real-time results** directly within their development tools. Living Documentation provides a single source of truth that evolves with your code and test cases. In Testomat.io, this means your automated tests don’t just verify functionality — they also become readable, shareable, and traceable documentation that supports collaboration and decision-making across the team.
**Living Documentation** is a dynamic, always-up-to-date view of your tests, test suites and system behavior. Instead of relying on static documents that quickly become outdated, teams can use Living Documentation to share **test coverage, scenario details, and real-time results** directly within their development tools. Living Documentation provides a single source of truth that evolves with your code and test cases. In Testomat.io, this means your automated tests don’t just verify functionality — they also become readable, shareable, and traceable documentation that supports collaboration and decision-making across the team.

- Non-technical stakeholders (e.g., Product Managers, Compliance Teams) can view test coverage and feature behavior without diving into code.
Makes it easy to review acceptance criteria or BDD scenarios.
Expand All @@ -30,49 +30,46 @@ Easily include documentation in Confluence pages, sprint reports, or product spe
- Make tests or suites publicly viewable, or embed internally for team access.
Useful for partners, clients, or external QA vendors.



## How To Enable Living Documentation
## Enable Living Documentation

Living Documentation can be enabled in Project Settings:

1. Go to Settings
2. Click on the Project tab
3. Enable **Share Living Docs** toggle
4. See the confirmation and generated link for Living Documentation
1. Go to **Settings**.
2. Click on the **Project** tab.
3. Enable **Share Living Docs** toggle.
4. See the confirmation and generated link for **Living Documentation**.

![Enabling Living Docs](./images/enabling_living_docs.png)

## How To Embed Living Documentation
## Embed Living Documentation

Living documentation can be embedded into your website, you have a possibility to:

- Embed specific suite
- Embed specific test
- Embed tests with a specific tag or Jira id
- Embed specific suite.
- Embed specific test.
- Embed tests with a specific tag or Jira id.

## Suite

To embed a suite you have to:
**To embed a suite you have to:**

1. Select a suite on a living documentation page.
2. Open a drop-down menu under three dots (...)
2. Open a drop-down menu under three dots (...).
3. Select **Copy embed URL** option.
4. See the confirmation message that embed URL has been copied to your clipboard.

![Embed a suite](./images/embed_suite.png)


## Test

To embed a test you have to :
**To embed a test you have to:**

1. Select a specific test on a living documentation page.
2. Open a drop-down menu under three dots (...)
2. Open a drop-down menu under three dots (...).
3. Select **Copy embed URL** option.
4. See the confirmation message that embed URL has been copied to your clipboard.

![Embed a test](./images/embed_a_test.png)

![Embed a test](./images/embed_test.png)

## Tests by Tag or Jira ID

Expand All @@ -88,49 +85,48 @@ To embed test with Jira id you need to follow this template (don't forget to rep
<iframe src="https://app.testomat.io/docs/projects/{project_slug}/tests/embed?jira_id={jira_id}"></iframe>
```

## Tests parameters
## Tests Parameters

You can provide extra parameters in the query string:

1. frame_params[expand_all] - expand all tests by default
2. frame_params[hide_code] - hide code in tests
3. frame_params[hide_description] - hide description in tests
4. frame_params[hide_attachments] - hide attachments in tests
1. frame_params[expand_all] - expand all tests by default.
2. frame_params[hide_code] - hide code in tests.
3. frame_params[hide_description] - hide description in tests.
4. frame_params[hide_attachments] - hide attachments in tests.

Example

```
<iframe src="https://app.testomat.io/docs/projects/{project_slug}/tests/embed?tag=@smoke&frame_params[expand_all]=1&frame_params[hide_code]=1"></iframe>
```

## Embed Link For Confluence
## Embed Link for Confluence

With Testomat.io Living documentation, you can enrich your Confluence by adding tests or suites.
This can be done within a Confluence page:

1. Open your Confluence page editor - click Insert
2. Type 'iframe' in search field
3. Select Iframe plugin
1. Open your Confluence page editor - click **Insert**.
2. Type **iframe** in the search field.
3. Select **Iframe plugin**.

![Iframe plugin in Confluence](./images/confluence_iframe.png)

4. Enter the embed URL you generated in the Living documentation
5. Fill in the fields of your choice
4. Enter the **embed URL** you generated in the Living documentation.
5. Fill in the fields of your choice.

For example: display: block; border: none; height: 100vh; width: 100%; height:100%;

![Embed URL in Confluence](./images/confluence_embed_URLD.png)

6. Click Publish.
6. Click **Publish**.

![Embed URL in Confluence](./images/confluence_embed_URLD.png)

## Search within Living Documentation

You can search for specific tests within Living Documentation. The search functionality works the same way as it does in the Tests tab in Testomatio. You can search using two parameters:
You can search for specific tests within **Living Documentation**. The search functionality works the same way as it does in the Tests tab in Testomatio. You can search using two parameters:

1. Search by tags – Type a tag into the search field. A list of tests that match the tag will be displayed under the search field.
1. **Search by tags** – Type a tag into the search field. A list of tests that match the tag will be displayed under the search field.

2. Search by keywords – Type a keyword into the search field. A list of tests that match the keyword will be displayed under the search field.
2. **Search by keywords** – Type a keyword into the search field. A list of tests that match the keyword will be displayed under the search field.

![Search Within Living Documentation](./images/Living_Doc_Search.png)

Expand Down
Loading