robotframework-roboview 0.0.1__tar.gz

robotframework_roboview-0.0.1/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

robotframework_roboview-0.0.1/PKG-INFO

@@ -0,0 +1,239 @@
+Metadata-Version: 2.4
+Name: robotframework-roboview
+Version: 0.0.1
+Summary: RoboView is a Visual Studio Code extension designed to help you manage keywords within your Robot Framework projects and improve overall test quality through built-in Robocop integration. Its primary goal is to provide a comprehensive overview of all keywords and their relationships, making it easier to understand and maintain your test automation codebase.
+License: Apache 2.0
+License-File: LICENSE.txt
+Author: viadee Unternehmensberatung AG
+Requires-Python: >=3.10,<3.14
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: coloredlogs (>=15.0.1,<16.0.0)
+Requires-Dist: fastapi (>=0.115.8,<0.116.0)
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Requires-Dist: numpy (>=2.2.4,<3.0.0)
+Requires-Dist: pydantic (>=2.11.4,<3.0.0)
+Requires-Dist: pydantic-settings (>=2.12.0,<3.0.0)
+Requires-Dist: pygments (>=2.19.1,<3.0.0)
+Requires-Dist: robotframework (>=7.2.2,<8.0.0)
+Requires-Dist: robotframework-browser (>=19.12.4,<20.0.0)
+Requires-Dist: robotframework-crypto (>=0.4.2,<0.5.0)
+Requires-Dist: robotframework-databaselibrary (>=2.4.1,<3.0.0)
+Requires-Dist: robotframework-robocop (>=7.2.0,<8.0.0)
+Requires-Dist: robotframework-seleniumlibrary (>=6.8.0,<7.0.0)
+Requires-Dist: scikit-learn (>=1.6.1,<2.0.0)
+Requires-Dist: starlette (>=0.46.0,<0.47.0)
+Requires-Dist: uvicorn (>=0.34.0,<0.35.0)
+Description-Content-Type: text/markdown
+
+# RoboView - Keyword Management in Robot Framework
+![banner](./static/github_banner.png)
+[![PyPI version](https://img.shields.io/pypi/v/robotframework-roboview.svg)](https://pypi.org/project/robotframework-roboview/)
+![license](https://img.shields.io/badge/license-Apache--2.0-green)
+![python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)
+
+
+RoboView is a Visual Studio Code extension designed to help you manage keywords within your Robot Framework projects and improve overall test quality through built-in Robocop integration. Its primary goal is to provide a comprehensive overview of all keywords and their relationships, making it easier to understand and maintain your test automation codebase.
+
+---
+
+## ✨ Key Features
+
+- 🗂️ **Workspace:** Automatically selects your current workspace project and generates comprehensive overviews.
+- 📈 **Dashboard:** Get key performance indicators and a general overview of your robot framework project.
+- 📝 **Keyword Overview & Filtering:** Instantly view all keywords of a selected file, filter by type (initialized, called).
+- ❓ **Global Filter:** Searches your files for any keywords lacking documentation, unused keywords or faulty keywords with cycle calling.
+- 📖 **Detailed Keyword Insights:** Select any keyword to see where it is defined, how often it is used (both in its own file and across the project), and view its documentation.
+- 🧩 **Similarity Detection:** Get information about similar or potentially duplicate keywords through similarity analysis of keyword source code.
+- 🧭 **Code Navigation:** Jump straight to a keyword’s definition with a simple Ctrl+Click.
+- 🛡️ **Robocop Integration:** Runs Robocop directly from within RoboView, inspect lint results in context, and use your custom configuration file (e.g. robocop.toml) out of the box.
+- 🔍 **Search & Sorting:** Quickly find keywords using the search bar and sort them by name or usage statistics.
+
+---
+
+## ⚙️ Installation Guide
+
+RoboView consists of two parts: a **backend** (Python package) and a **frontend** (Visual Studio Code extension).
+
+### ✅ Backend
+
+Install the backend via **pip**:
+
+```bash
+pip install robotframework-roboview
+```
+
+### ✅ Frontend
+
+The Frontend is available as a Visual Studio Code extension on the Marketplace – install it in seconds from the VS Code Extensions view.
+1. Open **Visual Studio Code**.
+2. Go to the **Extensions** view (`Ctrl+Shift+X` / `Cmd+Shift+X`).
+3. Search for **"RoboView"**.
+4. Install the RoboView extension by *viadee Unternehmensberatung AG*.
+
+---
+
+## 🛠️ GitHub
+
+You can find the RoboView source code and issue tracker on GitHub:
+
+👉 **https://github.com/viadee/robotframework-roboview**
+
+---
+
+## 📝 Notes and Recommendations
+
+- For Robocop to automatically detect your configuration, name the file **`robocop.toml`**, **`robot.toml`** or integrate in **`pyproject.toml`**.  
+  If you cannot change the filename in your project, you can instead set the environment variable **`ROBOCOP_CONFIG_PATH`** to the full path of your config file.
+- If the Robocop configuration file is outdated or cannot be parsed, RoboView falls back to **Robocop’s default settings**. The same applies if no configuration file is found.
+- RoboView follows your IDE’s color theme. We recommend using a **dark theme**, as text in light themes can be harder to read - but feel free to experiment and choose what works best for you.
+
+---
+
+## 🔍 How to navigate RoboView
+
+In the following three sections, we will dive deeper into how to navigate RoboView: where to find the features and understand the terminology we use. We start with the dashboard, then look at the keyword usage overview, and finally the Robocop integration.
+You can switch between these views using the buttons in the top-right corner of RoboView: <code>Dashboard</code>, <code>Keyword Usage</code>, and <code>Robocop</code>.
+
+## 📋 1) Dashboard
+
+The **Dashboard** gives you a high‑level overview of the selected Robot Framework project and its overall health.
+
+
+<p align="center">
+  <img src="./static/dashboard_1.png" alt="keyword_list" width="900"/>
+</p>
+<p align="center">
+  <img src="./static/dashboard_2.png" alt="keyword_list" width="900"/>
+</p>
+
+<br>
+
+At the top of the dashboard you’ll see the **Selected Project**. RoboView automatically detects your current workspace and shows:
+- The **project name**
+- The **absolute path** to the project root
+
+This ensures all metrics are calculated against the correct `.robot` and `.resource` files.
+
+### KPIs
+
+The **KPIs** section summarizes the most important metrics of your test suite:
+- **User Defined Keywords**: Total number of custom keywords found in your project.
+- **Keyword Reuse Rate**: Percentage of keywords that are used more than once. A higher value indicates better reuse and less duplication/redundancy.
+- **Unused Keywords**: Number of keywords that are never called anywhere in the project. Use this to identify dead code and candidates for cleanup.
+- **Robocop Issues**: Total number of Robocop violations detected across the project. This helps you quickly assess structural and style problems in your tests.
+- **Documentation Coverage**: Percentage of keywords that contain a `[Documentation]` section. A higher value means your test suite is better documented and easier to maintain.
+- **Robot Framework Files**: Total number of `.robot` and `.resource` files that were analyzed. Use the dashboard to quickly spot problematic areas (e.g. many unused keywords, low documentation coverage, or a high number of Robocop issues) and decide where to focus your refactoring or cleanup efforts first.
+
+
+## 🌳 2) Keyword Overview
+
+<p align="center" style="margin-bottom: 0.5em;">
+  <strong>Keyword Overview Layout</strong>
+</p>
+<p align="center" style="font-family: monospace; line-height: 1.4; white-space: pre;">
+[ Left: File Navigation &amp; Keyword Filters ]   [ Middle: Keyword List ]   [ Right: Keyword Details ]
+</p>
+
+<p align="center">
+  <img src="./static/keyword_usage.png" alt="graph_view" width="900"/>
+</p>
+
+<br>
+
+### ⬅️ Left Side – Navigation &amp; Filters
+
+- <strong>File Selection:</strong> At the top, a dropdown lets you select a file. The current VS Code workspace is used as root, and all
+  <code>.robot</code> and <code>.resource</code> files are available.
+- <strong>Type Filter:</strong> Choose which group of keywords to display for the selected file:
+    - <strong>All Keywords:</strong> Shows every keyword that is either defined in or used by the selected file.
+    - <strong>Initialized Keywords:</strong> Only keywords that are defined/implemented in the selected file.
+    - <strong>Called Keywords:</strong> Only keywords that are used in the selected file but defined elsewhere.
+- <strong>Global Filter:</strong> Jump directly to common problem areas across the entire project:
+    - <strong>Keywords without Documentation:</strong> Keywords that are missing documentation.
+    - <strong>Unused Keywords:</strong> Keywords that are never called in any analyzed file.
+    - <strong>Keywords with Calling Cycles:</strong> Keywords that participate in cyclic calls (A calls B, B calls A, etc.), which can indicate design or maintainability issues.
+
+<br>
+
+### 📊 Middle – Keyword List
+
+The middle section lists all keywords found in the selected file and shows key information about each of them:
+
+- <strong>Origin indicator:</strong> A color-coded label to the left of the keyword name shows where the keyword comes from:
+    - <strong>U</strong>: User-defined keyword.
+    - <strong>E</strong>: External keyword (e.g. from <code>BuiltIn</code> or libraries like <code>Browser</code>).
+- <strong>Definition location:</strong> The file in which the keyword is defined.
+- <strong>File-local usage count:</strong> How often the keyword is used (called) in the selected file.
+- <strong>Project-wide usage count:</strong> How often the keyword is used across all <code>.robot</code> and <code>.resource</code> files in the current project.
+
+<br>
+
+### ➡️ Right Side – Keyword Details
+
+When you select a keyword (by clicking a row in the middle table), the right panel shows detailed information:
+
+- <strong>Documentation:</strong> The keyword’s documentation as defined in the source code.
+- <strong>Usage across files:</strong> In which <code>.robot</code> and <code>.resource</code> files the keyword is used, and how often in each file.
+- <strong>Similarity analysis:</strong> A list of up to five keywords that are most similar to the selected one, based on its name and source code using term-frequency-based similarity.
+
+<br>
+
+---
+
+<h3 style="border-bottom: none; margin-bottom: 1em;">🛡️ 3) Robocop</h3>
+
+The **Robocop** view integrates the `https://robocop.readthedocs.io/` linter directly into RoboView, so you can spot and fix structural and style issues in your Robot Framework tests without leaving VS Code.
+
+<p align="center" style="margin-bottom: 0.5em;">
+  <strong>Robocop Issues Layout</strong>
+</p>
+<p align="center" style="font-family: monospace; line-height: 1.4; white-space: pre;">
+[ Left: Error Overview ]   [ Middle: Error List ]   [ Right: Error Details ]
+
+
+<p align="center">
+  <img src="./static/robocop.png" alt="robocop_issues" width="900"/>
+</p>
+
+
+<br>
+
+### How it works
+
+- **Left: Error Overview**  
+  The left panel shows a compact **overview of all detected issues**, for example:
+    - Total number of Robocop findings
+    - Issues grouped by **rule** or **category**
+    - A quick way to see which types of problems are most common
+      This helps you understand the overall state of your project at a glance.
+- **Middle: Error List**  
+  The middle panel contains the **list of individual Robocop issues**.  
+  Each entry typically shows:
+    - The **file** where the issue was found
+    - The **rule id** and short **message**
+    - The **line** number in the file
+
+  You can scroll through this list and select a specific issue to inspect it in detail.
+
+- **Right: Error Details**
+  The right panel displays **details for the currently selected issue**, including:
+    - The full Robocop message
+    - The rule id and its description
+    - The file and line information
+    - Additional context that helps you understand why this issue was reported
+
+<br>
+
+---
+
+## 🔮 Outlook
+
+RoboView is an actively evolving project. ✨  
+We’re continuously adding new features, polishing existing workflows, and exploring fresh ideas to make working with Robot Framework even more enjoyable. 💡
+
+We’re happy to have you along for the journey – stay tuned for new releases and improvements! 🚀

robotframework_roboview-0.0.1/README.md

@@ -0,0 +1,207 @@
+# RoboView - Keyword Management in Robot Framework
+![banner](./static/github_banner.png)
+[![PyPI version](https://img.shields.io/pypi/v/robotframework-roboview.svg)](https://pypi.org/project/robotframework-roboview/)
+![license](https://img.shields.io/badge/license-Apache--2.0-green)
+![python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)
+
+
+RoboView is a Visual Studio Code extension designed to help you manage keywords within your Robot Framework projects and improve overall test quality through built-in Robocop integration. Its primary goal is to provide a comprehensive overview of all keywords and their relationships, making it easier to understand and maintain your test automation codebase.
+
+---
+
+## ✨ Key Features
+
+- 🗂️ **Workspace:** Automatically selects your current workspace project and generates comprehensive overviews.
+- 📈 **Dashboard:** Get key performance indicators and a general overview of your robot framework project.
+- 📝 **Keyword Overview & Filtering:** Instantly view all keywords of a selected file, filter by type (initialized, called).
+- ❓ **Global Filter:** Searches your files for any keywords lacking documentation, unused keywords or faulty keywords with cycle calling.
+- 📖 **Detailed Keyword Insights:** Select any keyword to see where it is defined, how often it is used (both in its own file and across the project), and view its documentation.
+- 🧩 **Similarity Detection:** Get information about similar or potentially duplicate keywords through similarity analysis of keyword source code.
+- 🧭 **Code Navigation:** Jump straight to a keyword’s definition with a simple Ctrl+Click.
+- 🛡️ **Robocop Integration:** Runs Robocop directly from within RoboView, inspect lint results in context, and use your custom configuration file (e.g. robocop.toml) out of the box.
+- 🔍 **Search & Sorting:** Quickly find keywords using the search bar and sort them by name or usage statistics.
+
+---
+
+## ⚙️ Installation Guide
+
+RoboView consists of two parts: a **backend** (Python package) and a **frontend** (Visual Studio Code extension).
+
+### ✅ Backend
+
+Install the backend via **pip**:
+
+```bash
+pip install robotframework-roboview
+```
+
+### ✅ Frontend
+
+The Frontend is available as a Visual Studio Code extension on the Marketplace – install it in seconds from the VS Code Extensions view.
+1. Open **Visual Studio Code**.
+2. Go to the **Extensions** view (`Ctrl+Shift+X` / `Cmd+Shift+X`).
+3. Search for **"RoboView"**.
+4. Install the RoboView extension by *viadee Unternehmensberatung AG*.
+
+---
+
+## 🛠️ GitHub
+
+You can find the RoboView source code and issue tracker on GitHub:
+
+👉 **https://github.com/viadee/robotframework-roboview**
+
+---
+
+## 📝 Notes and Recommendations
+
+- For Robocop to automatically detect your configuration, name the file **`robocop.toml`**, **`robot.toml`** or integrate in **`pyproject.toml`**.  
+  If you cannot change the filename in your project, you can instead set the environment variable **`ROBOCOP_CONFIG_PATH`** to the full path of your config file.
+- If the Robocop configuration file is outdated or cannot be parsed, RoboView falls back to **Robocop’s default settings**. The same applies if no configuration file is found.
+- RoboView follows your IDE’s color theme. We recommend using a **dark theme**, as text in light themes can be harder to read - but feel free to experiment and choose what works best for you.
+
+---
+
+## 🔍 How to navigate RoboView
+
+In the following three sections, we will dive deeper into how to navigate RoboView: where to find the features and understand the terminology we use. We start with the dashboard, then look at the keyword usage overview, and finally the Robocop integration.
+You can switch between these views using the buttons in the top-right corner of RoboView: <code>Dashboard</code>, <code>Keyword Usage</code>, and <code>Robocop</code>.
+
+## 📋 1) Dashboard
+
+The **Dashboard** gives you a high‑level overview of the selected Robot Framework project and its overall health.
+
+
+<p align="center">
+  <img src="./static/dashboard_1.png" alt="keyword_list" width="900"/>
+</p>
+<p align="center">
+  <img src="./static/dashboard_2.png" alt="keyword_list" width="900"/>
+</p>
+
+<br>
+
+At the top of the dashboard you’ll see the **Selected Project**. RoboView automatically detects your current workspace and shows:
+- The **project name**
+- The **absolute path** to the project root
+
+This ensures all metrics are calculated against the correct `.robot` and `.resource` files.
+
+### KPIs
+
+The **KPIs** section summarizes the most important metrics of your test suite:
+- **User Defined Keywords**: Total number of custom keywords found in your project.
+- **Keyword Reuse Rate**: Percentage of keywords that are used more than once. A higher value indicates better reuse and less duplication/redundancy.
+- **Unused Keywords**: Number of keywords that are never called anywhere in the project. Use this to identify dead code and candidates for cleanup.
+- **Robocop Issues**: Total number of Robocop violations detected across the project. This helps you quickly assess structural and style problems in your tests.
+- **Documentation Coverage**: Percentage of keywords that contain a `[Documentation]` section. A higher value means your test suite is better documented and easier to maintain.
+- **Robot Framework Files**: Total number of `.robot` and `.resource` files that were analyzed. Use the dashboard to quickly spot problematic areas (e.g. many unused keywords, low documentation coverage, or a high number of Robocop issues) and decide where to focus your refactoring or cleanup efforts first.
+
+
+## 🌳 2) Keyword Overview
+
+<p align="center" style="margin-bottom: 0.5em;">
+  <strong>Keyword Overview Layout</strong>
+</p>
+<p align="center" style="font-family: monospace; line-height: 1.4; white-space: pre;">
+[ Left: File Navigation &amp; Keyword Filters ]   [ Middle: Keyword List ]   [ Right: Keyword Details ]
+</p>
+
+<p align="center">
+  <img src="./static/keyword_usage.png" alt="graph_view" width="900"/>
+</p>
+
+<br>
+
+### ⬅️ Left Side – Navigation &amp; Filters
+
+- <strong>File Selection:</strong> At the top, a dropdown lets you select a file. The current VS Code workspace is used as root, and all
+  <code>.robot</code> and <code>.resource</code> files are available.
+- <strong>Type Filter:</strong> Choose which group of keywords to display for the selected file:
+    - <strong>All Keywords:</strong> Shows every keyword that is either defined in or used by the selected file.
+    - <strong>Initialized Keywords:</strong> Only keywords that are defined/implemented in the selected file.
+    - <strong>Called Keywords:</strong> Only keywords that are used in the selected file but defined elsewhere.
+- <strong>Global Filter:</strong> Jump directly to common problem areas across the entire project:
+    - <strong>Keywords without Documentation:</strong> Keywords that are missing documentation.
+    - <strong>Unused Keywords:</strong> Keywords that are never called in any analyzed file.
+    - <strong>Keywords with Calling Cycles:</strong> Keywords that participate in cyclic calls (A calls B, B calls A, etc.), which can indicate design or maintainability issues.
+
+<br>
+
+### 📊 Middle – Keyword List
+
+The middle section lists all keywords found in the selected file and shows key information about each of them:
+
+- <strong>Origin indicator:</strong> A color-coded label to the left of the keyword name shows where the keyword comes from:
+    - <strong>U</strong>: User-defined keyword.
+    - <strong>E</strong>: External keyword (e.g. from <code>BuiltIn</code> or libraries like <code>Browser</code>).
+- <strong>Definition location:</strong> The file in which the keyword is defined.
+- <strong>File-local usage count:</strong> How often the keyword is used (called) in the selected file.
+- <strong>Project-wide usage count:</strong> How often the keyword is used across all <code>.robot</code> and <code>.resource</code> files in the current project.
+
+<br>
+
+### ➡️ Right Side – Keyword Details
+
+When you select a keyword (by clicking a row in the middle table), the right panel shows detailed information:
+
+- <strong>Documentation:</strong> The keyword’s documentation as defined in the source code.
+- <strong>Usage across files:</strong> In which <code>.robot</code> and <code>.resource</code> files the keyword is used, and how often in each file.
+- <strong>Similarity analysis:</strong> A list of up to five keywords that are most similar to the selected one, based on its name and source code using term-frequency-based similarity.
+
+<br>
+
+---
+
+<h3 style="border-bottom: none; margin-bottom: 1em;">🛡️ 3) Robocop</h3>
+
+The **Robocop** view integrates the `https://robocop.readthedocs.io/` linter directly into RoboView, so you can spot and fix structural and style issues in your Robot Framework tests without leaving VS Code.
+
+<p align="center" style="margin-bottom: 0.5em;">
+  <strong>Robocop Issues Layout</strong>
+</p>
+<p align="center" style="font-family: monospace; line-height: 1.4; white-space: pre;">
+[ Left: Error Overview ]   [ Middle: Error List ]   [ Right: Error Details ]
+
+
+<p align="center">
+  <img src="./static/robocop.png" alt="robocop_issues" width="900"/>
+</p>
+
+
+<br>
+
+### How it works
+
+- **Left: Error Overview**  
+  The left panel shows a compact **overview of all detected issues**, for example:
+    - Total number of Robocop findings
+    - Issues grouped by **rule** or **category**
+    - A quick way to see which types of problems are most common
+      This helps you understand the overall state of your project at a glance.
+- **Middle: Error List**  
+  The middle panel contains the **list of individual Robocop issues**.  
+  Each entry typically shows:
+    - The **file** where the issue was found
+    - The **rule id** and short **message**
+    - The **line** number in the file
+
+  You can scroll through this list and select a specific issue to inspect it in detail.
+
+- **Right: Error Details**
+  The right panel displays **details for the currently selected issue**, including:
+    - The full Robocop message
+    - The rule id and its description
+    - The file and line information
+    - Additional context that helps you understand why this issue was reported
+
+<br>
+
+---
+
+## 🔮 Outlook
+
+RoboView is an actively evolving project. ✨  
+We’re continuously adding new features, polishing existing workflows, and exploring fresh ideas to make working with Robot Framework even more enjoyable. 💡
+
+We’re happy to have you along for the journey – stay tuned for new releases and improvements! 🚀