doc: update README

HuolalaTech · Sep 3, 2024 · 3fd3083 · 3fd3083
1 parent f8e91fe
commit 3fd3083
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -93,7 +93,7 @@ yarn global add @huolala-tech/page-spy-api@latest
 npm install -g @huolala-tech/page-spy-api@latest
 ```
 
-After the download is complete, you can directly execute `page-spy-api` in the command line to start the service. Once the deployment is successful, you can open the browser and access `<host>:6752`, the `Inject SDK` menu will be at the top, and you can find how to configure and integrate in the business project by click the menu.
+After the download is complete, you can directly execute `page-spy-api` in the command line to start the service. After the startup is complete, visit `http://localhost:6752` on the browser. Once local testing is complete, you can deploy it to the server.
 
 ### Option 2: deploy by docker
 
@@ -105,20 +105,20 @@ After the download is complete, you can directly execute `page-spy-api` in the c
 docker run -d --restart=always -v ./log:/app/log -v ./data:/app/data -p 6752:6752 --name="pageSpy" ghcr.io/huolalatech/page-spy-web:latest
 ```
 
-Once the deployment is successful, you can open the browser and access `<host>:6752`, the `Inject SDK` menu will be at the top, and you can find how to configure and integrate in the business project by click the menu.
+After the startup is complete, visit `http://localhost:6752` on the browser. Once local testing is complete, you can deploy it to the server.
 
-## Community
+## How to contribute?
 
-Join us on our [Official Discord Server](https://discord.gg/ERPpNZkX)!
+Click to see the [Contributing](./CONTRIBUTING.md).
 
-## Roadmap
+## FAQ
 
-Click to see the [Roadmap](https://github.com/orgs/HuolalaTech/projects/1).
+Click to see the [FAQ](https://www.pagespy.org/#/docs/faq).
 
-## How to contribute?
+## Community
 
-Click to see the [Contributing](./CONTRIBUTING.md).
+Join us on our [Official Discord Server](https://discord.gg/ERPpNZkX)!
 
-## FAQ
+## Roadmap
 
-Click to see the [FAQ](https://github.com/HuolalaTech/page-spy-web/wiki/faq).
+Click to see the [Roadmap](https://github.com/orgs/HuolalaTech/projects/1).
diff --git a/README_JA.md b/README_JA.md
@@ -93,7 +93,7 @@ yarn global add @huolala-tech/page-spy-api@latest
 npm install -g @huolala-tech/page-spy-api@latest
 ```
 
-ダウンロードが完了したら、コマンドラインで `page-spy-api` を直接実行してサービスを開始することができます。デプロイが成功したら、ブラウザを開いて `<host>:6752` にアクセスすると、上部に `Inject SDK` メニューが表示され、メニューをクリックすると、ビジネスプロジェクトに設定および統合する方法が表示されます。
+ダウンロードが完了したら、コマンドラインで `page-spy-api` を直接実行してサービスを開始することができます。起動完了後、ブラウザで `http://localhost:6752` にアクセスし、ローカルテストが完了したらサーバーにデプロイすることができます。
 
 ### オプション 2: docker によるデプロイ
 
@@ -105,20 +105,20 @@ npm install -g @huolala-tech/page-spy-api@latest
 docker run -d --restart=always -v ./log:/app/log -v ./data:/app/data -p 6752:6752 --name="pageSpy" ghcr.io/huolalatech/page-spy-web:latest
 ```
 
-デプロイが成功したら、ブラウザを開いて `<host>:6752` にアクセスすると、上部に `Inject SDK` メニューが表示され、メニューをクリックすると、ビジネスプロジェクトに設定および統合する方法が表示されます。
+起動完了後、ブラウザで `http://localhost:6752` にアクセスし、ローカルテストが完了したらサーバーにデプロイすることができます。
 
-## コミュニティ
+## コントリビュートするには？
 
-[公式 Discord サーバー](https://discord.gg/ERPpNZkX)に参加してください！
+クリックして [Contributing](./CONTRIBUTING.md) をご覧ください。
 
-## ロードマップ
+## FAQ
 
-クリックして [Roadmap](https://github.com/orgs/HuolalaTech/projects/1) をご覧ください。
+クリックして [FAQ](https://www.pagespy.org/#/docs/faq) をご覧ください。
 
-## コントリビュートするには？
+## コミュニティ
 
-クリックして [Contributing](./CONTRIBUTING.md) をご覧ください。
+[公式 Discord サーバー](https://discord.gg/ERPpNZkX)に参加してください！
 
-## FAQ
+## ロードマップ
 
-クリックして [FAQ](https://github.com/HuolalaTech/page-spy-web/wiki/faq) をご覧ください。
+クリックして [Roadmap](https://github.com/orgs/HuolalaTech/projects/1) をご覧ください。
diff --git a/README_ZH.md b/README_ZH.md
@@ -93,7 +93,7 @@ yarn global add @huolala-tech/page-spy-api@latest
 npm install -g @huolala-tech/page-spy-api@latest
 ```
 
-安装完成之后你可以在命令行中直接执行 `page-spy-api` 启动服务。部署完成后浏览器访问 `<host>:6752`，页面顶部会出现 `接入 SDK` 菜单，点击菜单查看如何在业务项目中配置并集成。
+安装完成之后你可以在命令行中直接执行 `page-spy-api` 启动服务。启动完成后，打开浏览器访问 `http://localhost:6752` 体验，本地测试完成后即可部署到服务器上。
 
 ### 第二种：使用 Docker 部署
 
@@ -105,7 +105,7 @@ npm install -g @huolala-tech/page-spy-api@latest
 docker run -d --restart=always -v ./log:/app/log -v ./data:/app/data -p 6752:6752 --name="pageSpy" ghcr.io/huolalatech/page-spy-web:latest
 ```
 
-启动完成后浏览器访问 `<host>:6752`，页面顶部会出现 `接入 SDK` 菜单，点击菜单查看如何在业务项目中配置并集成。
+启动完成后，打开浏览器访问 `http://localhost:6752` 体验，本地测试完成后即可部署到服务器上。
 
 ## 技术支持
 

diff --git a/src/components/DetailBlock/index.tsx b/src/components/DetailBlock/index.tsx
@@ -1,10 +1,10 @@
 import React, { ReactNode } from 'react';
 import './index.less';
 
-type Props = {
+interface Props {
   title?: string | ReactNode;
   children?: ReactNode;
-};
+}
 
 const DetailBlock = (props: Props) => {
   return (