Skip to content

Commit fd140d0

Browse files
committed
docs: update about and remove playground
1 parent c076b38 commit fd140d0

File tree

5 files changed

+22
-100
lines changed

5 files changed

+22
-100
lines changed

docs/01_about/index.md

Lines changed: 22 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,54 @@
1-
# About
1+
# About RobotCode
22

3-
[![Visual Studio Marketplace](https://img.shields.io/visual-studio-marketplace/v/d-biehl.robotcode?style=flat&label=VS%20Marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)
3+
[![VS Marketplace](https://img.shields.io/visual-studio-marketplace/v/d-biehl.robotcode?style=flat&label=VS%20Marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)
44
[![Installs](https://img.shields.io/visual-studio-marketplace/i/d-biehl.robotcode?style=flat)](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)
55
[![Build Status](https://img.shields.io/github/actions/workflow/status/robotcodedev/robotcode/build-test-package-publish.yml?branch=main&style=flat&logo=github)](https://github.com/robotcodedev/robotcode/actions?query=workflow:build_test_package_publish)
66
[![License](https://img.shields.io/github/license/robotcodedev/robotcode?style=flat&logo=apache)](https://github.com/robotcodedev/robotcode/blob/master/LICENSE)
77
[![PyPI - Version](https://img.shields.io/pypi/v/robotcode.svg?style=flat)](https://pypi.org/project/robotcode)
88
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/robotcode.svg?style=flat)](https://pypi.org/project/robotcode)
99
[![PyPI - Downloads](https://img.shields.io/pypi/dm/robotcode.svg?style=flat&label=downloads)](https://pypi.org/project/robotcode/)
1010

11-
----
11+
---
1212

13-
*RobotCode* is an [extension](https://marketplace.visualstudio.com/VSCode) that provides comprehensive support for [RobotFramework](https://robotframework.org/) in [Visual Studio Code](https://code.visualstudio.com/). It offers a wide range of features, including code completion, debugging, test explorer, refactoring, and more!
13+
**RobotCode** is your all-in-one extension for working with the [Robot Framework](https://robotframework.org/) in [Visual Studio Code](https://code.visualstudio.com/). Whether you're writing, testing, or debugging, RobotCode provides a comprehensive toolkit that makes every aspect of your development process smoother and more efficient.
1414

15-
## Features
16-
17-
With RobotCode you can edit your code with auto-completion, code navigation, syntax checking and many more.
18-
Here is a list of Features:
19-
20-
- [About](#about)
21-
- [Features](#features)
22-
- [Autocomplete and IntelliSense](#autocomplete-and-intellisense)
23-
- [Code Navigation](#code-navigation)
24-
- [Diagnostics and Linting](#diagnostics-and-linting)
25-
- [Code Formatting](#code-formatting)
26-
- [Running and Debugging](#running-and-debugging)
27-
- [Multi-root Workspace folders](#multi-root-workspace-folders)
15+
## Key Features
2816

2917
### Autocomplete and IntelliSense
3018

31-
Autocompletion for:
32-
- Libraries with parameters
33-
- Resources,
34-
- Variables
35-
- Keywords with parameters
36-
- Namespaces
19+
- **Comprehensive Autocompletion:** Say goodbye to tedious typing! RobotCode provides autocompletion for libraries, resources, variables, and keywords, ensuring you always have the right tools at your fingertips. This includes support for local variables, resources, file-based variables (like Python and YAML), and command line variables, both static and dynamic.
20+
- **Context-Aware Suggestions:** IntelliSense offers context-sensitive suggestions, helping you code faster with fewer errors. It’s perfect for those moments when you can’t quite remember the exact syntax.
3721

3822
![Autocomplete Libraries and Keywords](images/autocomplete1.gif)
3923

40-
Autocompletion supports all supported variables types
41-
- local variables
42-
- variables from resource files
43-
- variables from variables file (.py and .yaml)
44-
- static and dynamic
45-
- command line variables
46-
- builtin variables
47-
48-
![Autocomplete Variables](images/autocomplete2.gif)
49-
5024
### Code Navigation
5125

52-
- Symbols
53-
- Goto definitions and implementations
54-
- Keywords
55-
- Variables
56-
- Libraries
57-
- Resources
58-
- Find references
59-
- Keywords
60-
- Variables
61-
- Imports
62-
- Libraries
63-
- Resources
64-
- Variables
65-
- Tags
66-
- Errors and Warnings
26+
- **Quick Symbol Navigation:** Easily move through your code with RobotCode’s symbol navigation, allowing you to jump straight to definitions, implementations, or references for keywords, variables, libraries, and resources.
27+
- **Error and Warning Diagnostics:** Stay on top of your code quality with real-time diagnostics that highlight errors and warnings as you code, so you can fix issues before they escalate.
6728

6829
### Diagnostics and Linting
6930

70-
RobotCode analyse your code and show diagnostics for:
71-
72-
- Syntax Errors
73-
- Unknown keywords
74-
- Duplicate keywords
75-
- Missing libraries, resource and variable imports
76-
- Duplicate libraries, resource and variable imports
77-
- ... and many more
78-
79-
For most things RobotCode uses the installed RobotFramework version to parse and analyse the code, so you get the same errors as when you run it.
80-
81-
82-
Get additional code analysis with [Robocop](https://robocop.readthedocs.io/). Just install it in your python environment.
31+
- **Real-Time Code Analysis:** RobotCode continuously monitors your code for syntax errors, unknown keywords, and issues with library or resource imports. This proactive approach helps you catch and resolve problems early in the development process.
32+
- **Seamless Integration with Robot Framework:** RobotCode uses the version of Robot Framework installed in your environment for diagnostics, ensuring accuracy and consistency with your actual test runs.
33+
- **Enhanced Linting with Robocop:** For developers who want to go further, RobotCode integrates with [Robocop](https://robocop.readthedocs.io/) to provide even more detailed analysis and linting, giving you insights into how to optimize your code.
8334

8435
### Code Formatting
8536

86-
RobotCode can format your code with the internal RobotFramework robot.tidy tool (deprecated), but also with [Robotidy](https://robotidy.readthedocs.io/). Just install it.
37+
- **Automatic Code Formatting:** Keep your code clean and consistent with RobotCode’s formatting tools. You can choose to use the built-in `robot.tidy` tool (now deprecated) or the more powerful [Robotidy](https://robotidy.readthedocs.io/). With just a few clicks, your code is neatly organized and ready for review.
38+
- **Customizable Formatting Options:** Tailor the formatting rules to suit your project’s needs, ensuring that your codebase remains consistent and easy to read.
8739

8840
### Running and Debugging
8941

90-
RobotCode supports running and debugging of RobotFramework testcases and tasks out of the box, directly from the definition of the test or suite.
42+
- **Integrated Testing and Debugging:** RobotCode allows you to run and debug your Robot Framework test cases directly from within Visual Studio Code. This tight integration means you can execute tests, set breakpoints, and step through code without leaving the editor.
43+
- **Real-Time Log Navigation:** While debugging, RobotCode provides a live view of log messages in the debug console, allowing you to quickly identify and navigate to the source of any issues.
9144

9245
![Running Tests](images/running_tests.gif)
9346

94-
In the debug console you can see all log messages of the current run and navigate to the keyword the message was written by.
47+
### Multi-root Workspace Support
48+
49+
- **Manage Multiple Projects Seamlessly:** With support for [Multi-root Workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces), RobotCode allows you to work on multiple Robot Framework projects simultaneously, each with its own settings and Python environments. Whether you prefer to have separate environments or share the same one across projects, RobotCode offers the flexibility to match your workflow.
50+
- **Smooth Workflow Transitions:** Easily switch between different projects and configurations without losing your place or context, making it easier to manage complex development environments and large codebases.
9551

96-
### Multi-root Workspace folders
52+
---
9753

98-
RobotCodes support for [Multi-root Workspaces](https://code.visualstudio.com/docs/editor/multi-root-workspaces), enables loading and editing different Robotframework projects/folders with different RobotFramework/Python environments and settings at the same time or you can share the same RobotFramework/Python environment and settings for all folders in the workspace.
54+
**RobotCode** isn’t just a tool—it’s your coding partner. With its powerful features and seamless integration, RobotCode helps you be more productive and enjoy your coding experience. Whether you’re a seasoned Robot Framework user or just getting started, RobotCode is here to help you build, test, and deploy with confidence. Let's create something amazing together!
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/99_features.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

0 commit comments

Comments
 (0)