diff --git a/src/content/docs/advanced/living-doc/images/Living_Doc_Search.png b/src/content/docs/advanced/living-doc/images/Living_Doc_Search.png index 025fc498..ccca8f84 100644 Binary files a/src/content/docs/advanced/living-doc/images/Living_Doc_Search.png and b/src/content/docs/advanced/living-doc/images/Living_Doc_Search.png differ diff --git a/src/content/docs/advanced/living-doc/images/confluence_embed_URLD.png b/src/content/docs/advanced/living-doc/images/confluence_embed_URLD.png index b2073ad6..ce0fdfaf 100644 Binary files a/src/content/docs/advanced/living-doc/images/confluence_embed_URLD.png and b/src/content/docs/advanced/living-doc/images/confluence_embed_URLD.png differ diff --git a/src/content/docs/advanced/living-doc/images/confluence_iframe.png b/src/content/docs/advanced/living-doc/images/confluence_iframe.png index 739a8fe1..1f915e37 100644 Binary files a/src/content/docs/advanced/living-doc/images/confluence_iframe.png and b/src/content/docs/advanced/living-doc/images/confluence_iframe.png differ diff --git a/src/content/docs/advanced/living-doc/images/embed_a_test.png b/src/content/docs/advanced/living-doc/images/embed_a_test.png deleted file mode 100644 index 453d4dc0..00000000 Binary files a/src/content/docs/advanced/living-doc/images/embed_a_test.png and /dev/null differ diff --git a/src/content/docs/advanced/living-doc/images/embed_suite.png b/src/content/docs/advanced/living-doc/images/embed_suite.png index 08fc59c8..22352398 100644 Binary files a/src/content/docs/advanced/living-doc/images/embed_suite.png and b/src/content/docs/advanced/living-doc/images/embed_suite.png differ diff --git a/src/content/docs/advanced/living-doc/images/embed_test.png b/src/content/docs/advanced/living-doc/images/embed_test.png new file mode 100644 index 00000000..ed858f14 Binary files /dev/null and b/src/content/docs/advanced/living-doc/images/embed_test.png differ diff --git a/src/content/docs/advanced/living-doc/images/enabling_living_docs.png b/src/content/docs/advanced/living-doc/images/enabling_living_docs.png index b94ceb49..91577977 100644 Binary files a/src/content/docs/advanced/living-doc/images/enabling_living_docs.png and b/src/content/docs/advanced/living-doc/images/enabling_living_docs.png differ diff --git a/src/content/docs/advanced/living-doc/index.md b/src/content/docs/advanced/living-doc/index.md index 9081a2c2..138e978b 100644 --- a/src/content/docs/advanced/living-doc/index.md +++ b/src/content/docs/advanced/living-doc/index.md @@ -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. @@ -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 @@ -88,14 +85,14 @@ To embed test with Jira id you need to follow this template (don't forget to rep ``` -## 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 @@ -103,34 +100,33 @@ Example ``` -## 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)