Added short descriptions to actions and refined READMEs for each

roboto-ai · Dec 22, 2023 · 1f62f29 · 1f62f29
1 parent 8939156
commit 1f62f29
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 31 deletions.
diff --git a/actions/px4_flight_review/action.json b/actions/px4_flight_review/action.json
@@ -1,23 +1,21 @@
 {
     "name": "px4_flight_review",
-    "description": "This Action creates a .html file with PX4 Flight Plots",
+    "short_description": "Generate interactive plots to analyze PX4 flights.",
+    "description": "This Action extracts data from ULog files (.ulg) and generates interactive html plots to analyze PX4 flights. Under the hood, it uses the [flight_review](https://github.com/PX4/flight_review) library that is maintained by the PX4 community.",
     "compute_requirements": {
         "vCPU": 1024,
         "memory": 2048,
         "storage": 21
     },
     "parameters": [
-    {
-    "name": "SAVE_PDF",
-    "required": false,
-    "description": "Set True to save a .pdf",
-    "default": "False"
-    }
-    ],
-    "tags": [
-        "px4",
-        "ulg"
+        {
+            "name": "SAVE_PDF",
+            "required": false,
+            "description": "Set True to save a .pdf",
+            "default": "False"
+        }
     ],
+    "tags": ["px4", "ulg"],
     "metadata": {
         "github_url": "https://github.com/roboto-ai/robologs-px4-actions/tree/main/actions/px4_flight_review"
     }

diff --git a/actions/ulog_info/README.md b/actions/ulog_info/README.md
@@ -1,6 +1,6 @@
 # ulog_info
 
-This Action gets .ulg metadata via [pyulog](https://github.com/PX4/pyulog)
+This Action extracts metadata from a ULog file (.ulg) via [pyulog](https://github.com/PX4/pyulog)
 
 ## Getting started
 

diff --git a/actions/ulog_info/action.json b/actions/ulog_info/action.json
@@ -1,11 +1,12 @@
 {
     "name": "ulog_info",
-    "description": "This Actions get .ulg metadata",
+    "short_description": "Extract metadata from ULog files.",
+    "description": "This Action extracts metadata from ULog files (.ulg). Under the hood, it uses the [pyulog](https://github.com/PX4/pyulog) library.\n\nBy default, a hidden markdown dotfile will be produced and rendered as ULog file metadata in Roboto.",
     "parameters": [
         {
             "name": "HIDDEN",
             "required": false,
-            "description": "Hide metadata markdown files.",
+            "description": "Hide metadata markdown files",
             "default": "True"
         }
     ],
@@ -14,10 +15,7 @@
         "memory": 2048,
         "storage": 21
     },
-    "tags": [
-        "px4",
-        "ulg"
-    ],
+    "tags": ["px4", "ulg"],
     "metadata": {
         "github_url": "https://github.com/roboto-ai/robologs-px4-actions/tree/main/actions/ulog_info"
     }

diff --git a/actions/ulog_to_csv/README.md b/actions/ulog_to_csv/README.md
@@ -1,6 +1,6 @@
 # ulog_to_csv
 
-This Action converts ulg files to csv files via [pyulog](https://github.com/PX4/pyulog)
+This Action converts data in ULog files (.ulg) to CSV via [pyulog](https://github.com/PX4/pyulog)
 
 ## Getting started
 

diff --git a/actions/ulog_to_csv/action.json b/actions/ulog_to_csv/action.json
@@ -1,40 +1,36 @@
 {
     "name": "ulog_to_csv",
-    "description": "This Actions converts .ulg files to .csv files",
+    "short_description": "Convert data in ULog files to CSV.",
+    "description": "This Action converts data in ULog files (.ulg) to CSV. Under the hood, it uses the [pyulog](https://github.com/PX4/pyulog) library.\n\nBy default, all messages will be extracted from the input file(s). You can use the parameters to extract specific message types, and also provide a specific time range if needed. These help to reduce the size of the resulting file.",
     "parameters": [
         {
             "name": "MESSAGES",
             "required": false,
             "description": "Comma-separated list of messages to extract. For example: battery_status,actuator_armed"
         },
-	{
+        {
             "name": "DELIMITER",
             "required": false,
-            "description": "Use delimiter in CSV, default is ','",
-	    "default": ","
+            "description": "Delimiter in CSV, defaults to comma",
+            "default": ","
         },
-	{
+        {
             "name": "TIME_START",
             "required": false,
             "description": "Start time for processing logs [s]"
         },
-	{
+        {
             "name": "TIME_END",
             "required": false,
             "description": "Finish time for processing logs [s]"
         }
-
     ],
     "compute_requirements": {
         "vCPU": 1024,
         "memory": 2048,
         "storage": 21
     },
-    "tags": [
-        "px4",
-        "ulg",
-	"ulog"
-    ],
+    "tags": ["px4", "ulg", "ulog"],
     "metadata": {
         "github_url": "https://github.com/roboto-ai/robologs-px4-actions/tree/main/actions/ulog_to_csv"
     }