Merge pull request #23 from QQDQ/main

init v1

neuronex/directory.json

@@ -3,11 +3,42 @@
     {
       "title": "产品概览",
       "path": "./",
-      "children": []
+      "children": [
+        {
+          "title": "架构",
+          "path": "intro/architecture"
+        },
+        {
+          "title": "数采模块列表",
+          "path": "intro/plugin-list"
+        },
+        {
+          "title": "许可证政策",
+          "path": "intro/license-policy"
+        }
+      ]
     },
     {
-      "title": "插件",
-      "path": "intro/plugin-list"
+      "title": "快速入门",
+      "path": "quick_start/quick_start"
+    },
+    {
+      "title": "安装",
+      "path": "install/introduction",
+      "children": [
+        {
+          "title": "使用 .tar.gz 包安装",
+          "path": "install/linux"
+        },
+        {
+          "title": "通过Docker部署",
+          "path": "install/docker"
+        },
+        {
+          "title": "申请和安装许可证",
+          "path": "install/license_setting"
+        }
+      ]
     },
     {
       "title": "数据采集配置",
@@ -18,10 +49,6 @@
           "path": "config/south-devices/south-devices",
           "collapsed": true,
           "children": [
-            {
-              "title": "File",
-              "path": "config/south-devices/file/file"
-            },
             {
               "title": "Modbus RTU",
               "path": "config/south-devices/modbus-rtu/modbus-rtu",
@@ -236,6 +263,10 @@
             {
               "title": "导入/导出点位配置",
               "path": "config/import-export"
+            },
+            {
+              "title": "基于模板配置",
+              "path": "config/templates/templates"
             }
           ]
         },
@@ -284,13 +315,17 @@
         {
           "title": "订阅南向数据",
           "path": "config/subscription"
+        },
+        {
+          "title": "管理插件模块",
+          "path": "config/ecp_edge_plugin"
+        },
+        {
+          "title": "数据监控",
+          "path": "monitor/introduction"
         }
       ]
     },
-    {
-      "title": "数据监控",
-      "path": "monitor/introduction"
-    },
     {
       "title": "数据流处理",
       "path": "streaming-processing/overview",
@@ -458,9 +493,25 @@
       ]
       },
       {
-        "title": "管理",
+        "title": "HTTP API",
+        "path": "api/api"
+      },
+      {
+        "title": "运维指南",
         "path": "management/introduction",
         "children": [
+          {
+            "title": "数据监控",
+            "path": "management/monitoring"
+          },
+          {
+            "title": "数据统计",
+            "path": "management/data-statistics"
+          },
+          {
+            "title": "配置管理",
+            "path": "management/conf-management"
+          },
           {
             "title": "日志",
             "path": "management/logs"
@@ -935,7 +986,7 @@
       ]
       },
       {
-        "title": "管理",
+        "title": "运维指南",
         "path": "management/introduction",
         "children": [
           {
@@ -948,6 +999,10 @@
           }
         ]
       },
+      {
+        "title": "HTTP API",
+        "path": "http-api/http-api"
+      },
       {
         "title": "发版历史",
         "path": "release_history/release_history"

neuronex/zh_CN/api/api.md

@@ -0,0 +1,18 @@
+# HTTP API
+
+IIoT平台或其他监控应用可以通过使用提供的HTTP-API来监视和控制Neuron设备。这些API的关键功能如下：
+
+[获取数据：](./rw.md) HTTP-API允许平台监视与IIoT平台连接的设备所获取的数据。这使得能够实时监控传感器读数、操作参数和设备状态。
+
+[控制命令：](./rw.md) API还支持向Neuron设备发送控制命令，使平台能够远程控制和管理设备。这实现了对设备功能的无缝管理。
+
+[远程设置和配置：](./configuration.md) 平台可以通过HTTP-API远程设置和配置设备连接。这确保了在无需物理访问的情况下方便高效地管理设备。[插件设置](./plugin-setting.md) 也可用。
+
+[JWT身份验证：](./jwt.md) API采用JWT身份验证，确保IIoT平台或监控应用与Neuron设备之间的安全通信和身份验证。这增强了系统的整体安全性。
+
+[Prometheus兼容指标：](./metrics.md) API提供与Prometheus兼容的指标数据。这使得可以轻松与Prometheus监控工具集成，便于对设备指标进行有效监控和分析。
+
+[错误代码描述：](./data-type.md) API包括全面的错误代码描述，提供有关遇到的错误的性质和原因的信息。这有助于有效的故障排除和问题解决。
+
+[数据类型描述：](./error-code.md) 为了确保数据的表示和解释清晰一致，API描述了使用的数据类型。这促进了IIoT平台或监控应用中数据的无缝集成和分析。
+