Skip to content

Commit

Permalink
fix: fix docs links (#2224)
Browse files Browse the repository at this point in the history
  • Loading branch information
hexf00 committed May 11, 2024
1 parent b51d22e commit 5f26e90
Show file tree
Hide file tree
Showing 18 changed files with 31 additions and 31 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- https://univer.ai/guides/contributing/ -->
<!-- https://univer.ai/guides/sheet/contributing/ -->

# Univer Contributing Guide

Expand Down Expand Up @@ -169,4 +169,4 @@ npm create @univerjs/cli init <project-name>

## Links

* [How to Contribute to Facade API](./packages/facade/docs/CONTRIBUTING.md)
* [How to Contribute to Facade API](./packages/facade/docs/CONTRIBUTING.md)
6 changes: 3 additions & 3 deletions README-ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,12 +72,12 @@ Univer は、スプレッドシート、ドキュメント、スライドを含
| <h3>🎨 Univer Slides</h3> | |
| [Slides](https://www.univer.ai/examples/slides/)<br>A canvas presentation containing graphic text, floating pictures, tables and other elements | [![](./docs/img/examples-slides.gif)](https://www.univer.ai/examples/slides/) |
| <h3>🧩 Univer Innovation</h3> | |
| [Zen Mode](https://univer.ai/guides/tutorials/zen-editor/#live-demo)<br>The cell of Sheet is a Doc? | [![](./docs/img/zen-mode.gif)](https://univer.ai/guides/tutorials/zen-editor/#live-demo) |
| [Zen Mode](https://univer.ai/guides/sheet/tutorials/zen-editor/#live-demo)<br>The cell of Sheet is a Doc? | [![](./docs/img/zen-mode.gif)](https://univer.ai/guides/sheet/tutorials/zen-editor/#live-demo) |
| [Univer(SaaS version)](https://univer.ai/)<br>With Univer, we enable users to create 3 forms of page as they wish. By merging sheet, doc and slide's capabilities together, Univer empowers individuals and teams to create, organize and streamline workflows effortlessly. | [![](./docs/img/univer-workspace-drag-chart.gif)](https://youtu.be/kpV0MvQuFZA) |

## 使い方

Univer を npm パッケージとしてインポートすることをお勧めします。ドキュメントサイトの [Quick Start](https://univer.ai/ja-jp/guides/quick-start/) セクションをご覧ください。また、[オンラインプレイグラウンド](https://univer.ai/playground/)では、開発環境を構築することなく Univer をプレビューすることができます。
Univer を npm パッケージとしてインポートすることをお勧めします。ドキュメントサイトの [Quick Start](https://univer.ai/guides/sheet/getting-started/quickstart) セクションをご覧ください。また、[オンラインプレイグラウンド](https://univer.ai/playground/)では、開発環境を構築することなく Univer をプレビューすることができます。

Univer はプラグインアーキテクチャを採用しています。以下のパッケージをインストールすることで、Univer の機能を拡張することができます。

Expand Down Expand Up @@ -143,7 +143,7 @@ Univer プロジェクトの成長と開発は、バッカーやスポンサー

## リンク

- [ドキュメント](https://univer.ai/ja-jp/guides/introduction/)
- [ドキュメント](https://univer.ai/guides/sheet/introduction)
- [Online Playground](https://univer.ai/playground/)
- [公式 Website](https://univer.ai)

Expand Down
8 changes: 4 additions & 4 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,12 @@ Univer 的亮点包括:
| <h3>🎨 Univer Slides</h3> | |
| [Slides](https://www.univer.ai/examples/slides/)<br>一个包含图文本、浮动图片、表格等元素的画布演示 | [![](./docs/img/examples-slides.gif)](https://www.univer.ai/examples/slides/) |
| <h3>🧩 Univer Innovation</h3> | |
| [Zen Mode](https://univer.ai/zh-cn/guides/tutorials/zen-editor/#%E6%BC%94%E7%A4%BA)<br>Sheet 的单元格是一个 Doc? | [![](./docs/img/zen-mode.gif)](https://univer.ai/zh-cn/guides/tutorials/zen-editor/#%E6%BC%94%E7%A4%BA) |
| [Zen Mode](https://univer.ai/zh-CN/guides/sheet/tutorials/zen-editor/#%E6%BC%94%E7%A4%BA)<br>Sheet 的单元格是一个 Doc? | [![](./docs/img/zen-mode.gif)](https://univer.ai/zh-CN/guides/sheet/tutorials/zen-editor/#%E6%BC%94%E7%A4%BA) |
| [Univer (SaaS version)](https://univer.ai/)<br>通过 Univer,我们使用户能够根据自己的意愿创建 3 种形式的页面。 通过将工作表、文档和幻灯片的功能合并在一起,Univer 使个人和团队能够轻松创建、组织和简化工作流程。 | [![](./docs/img/univer-workspace-drag-chart.gif)](https://youtu.be/kpV0MvQuFZA) |

## 使用

我们建议通过将 Univer 作为 npm 包使用,请参考文档上的[快速开始](https://univer.ai/guides/quick-start/)小节。我们还准备了一个[在线 playground](https://univer.ai/playground/),你无需在本地安装 Univer 就可以体验使用 Univer 开发。
我们建议通过将 Univer 作为 npm 包使用,请参考文档上的[快速开始](https://univer.ai/zh-CN/guides/sheet/getting-started/quickstart)小节。我们还准备了一个[在线 playground](https://univer.ai/playground/),你无需在本地安装 Univer 就可以体验使用 Univer 开发。

Univer 基于插件化架构设计,你可以安装以下包来增强 Univer 的功能。

Expand Down Expand Up @@ -144,7 +144,7 @@ Univer 持续稳定发展离不开它的支持者和赞助者,如果你想要

## 链接

- [文档](https://univer.ai/guides/introduction/)
- [文档](https://univer.ai/zh-CN/guides/sheet/introduction)
- [在线 Playground](https://univer.ai/playground/)
- [官方网站](https://univer.ai)

Expand All @@ -154,7 +154,7 @@ Univer 持续稳定发展离不开它的支持者和赞助者,如果你想要
- [Github Discussions](https://github.com/dream-num/univer/discussions)
- 微信扫描下方二维码,加入 Univer 中文社群

![wecom-qr-code](https://univer.ai/_astro/business-qr-code.3zPwMdHH_ZGnJEl.webp)
![wecom-qr-code](https://univer.ai/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Fqrcode.45c72be6.png&w=828&q=75)

## 授权

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,12 @@ Highlights:
| <h3>🎨 Univer Slides</h3> | |
| [Slides](https://www.univer.ai/examples/slides/)<br>A canvas presentation containing graphic text, floating pictures, tables and other elements | [![](./docs/img/examples-slides.gif)](https://www.univer.ai/examples/slides/) |
| <h3>🧩 Univer Innovation</h3> | |
| [Zen Mode](https://univer.ai/guides/tutorials/zen-editor/#live-demo)<br>The cell of Sheet is a Doc? | [![](./docs/img/zen-mode.gif)](https://univer.ai/guides/tutorials/zen-editor/#live-demo) |
| [Zen Mode](https://univer.ai/guides/sheet/tutorials/zen-editor/#live-demo)<br>The cell of Sheet is a Doc? | [![](./docs/img/zen-mode.gif)](https://univer.ai/guides/sheet/tutorials/zen-editor/#live-demo) |
| [Univer (SaaS version)](https://univer.ai/)<br>With Univer, we enable users to create 3 forms of page as they wish. By merging sheet, doc and slide's capabilities together, Univer empowers individuals and teams to create, organize and streamline workflows effortlessly. | [![](./docs/img/univer-workspace-drag-chart.gif)](https://youtu.be/kpV0MvQuFZA) |

## Usage

We recommend to import Univer as a npm package. Please checkout the [Quick Start](https://univer.ai/guides/quick-start/) section on the documentation website. We also have an [online playground](https://univer.ai/playground/) which can help you preview Univer without setting up the development environment.
We recommend to import Univer as a npm package. Please checkout the [Quick Start](https://univer.ai/guides/sheet/getting-started/quickstart) section on the documentation website. We also have an [online playground](https://univer.ai/playground/) which can help you preview Univer without setting up the development environment.

Univer bases on a plugin architecture. You can install the following packages to enhance the functionality of Univer.

Expand Down Expand Up @@ -144,7 +144,7 @@ Thanks to our sponsors, just part of them are listed here because of the space l

## Links

- [Documentation](https://univer.ai/guides/introduction/)
- [Documentation](https://univer.ai/guides/sheet/introduction)
- [Online Playground](https://univer.ai/playground/)
- [Official Website](https://univer.ai)

Expand Down
2 changes: 1 addition & 1 deletion packages/design/README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
![](./assets/design.jpeg)

:::note
如果你只需要扩展工具栏、右键菜单等,可以直接使用 @univerjs/ui 提供的扩展接口,无需自行实现 UI。请参考[扩展 UI](https://univer.ai/zh-cn/guides/customization/ui)
如果你只需要扩展工具栏、右键菜单等,可以直接使用 @univerjs/ui 提供的扩展接口,无需自行实现 UI。请参考[扩展 UI](https://univer.ai/zh-CN/guides/sheet/customization/ui)
:::

## 使用指南
Expand Down
2 changes: 1 addition & 1 deletion packages/design/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The components are developed using React and less, and you can find out more inf
![](./assets/design.jpeg)

:::note
If you only need to extend the toolbar, context menu, and so on, you can directly use the extension interfaces provided by `@univerjs/ui` without implementing the UI yourself. For more information, please refer to [Extending UI](https://univer.ai/guides/customization/ui).
If you only need to extend the toolbar, context menu, and so on, you can directly use the extension interfaces provided by `@univerjs/ui` without implementing the UI yourself. For more information, please refer to [Extending UI](https://univer.ai/guides/sheet/customization/ui).
:::

## Usage
Expand Down
2 changes: 1 addition & 1 deletion packages/docs-ui/README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
`@univerjs/docs-ui` 提供了 Doc 的 UI。

:::info
`@univerjs/docs-ui` 仍在试验阶段,建议不要在生产环境中使用。你可以在[路线图](/guides/roadmap)了解迭代计划。
`@univerjs/docs-ui` 仍在试验阶段,建议不要在生产环境中使用。你可以在[路线图](https://univer.ai/guides/sheet/roadmap)了解迭代计划。
:::

## 使用指南
Expand Down
2 changes: 1 addition & 1 deletion packages/docs-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
`@univerjs/docs-ui` package provides the User Interface for Docs.

:::info
`@univerjs/docs-ui` is still in the experimental phase. It is not recommended for use in production environments. You can learn about the iteration plans on the [roadmap](/guides/roadmap).
`@univerjs/docs-ui` is still in the experimental phase. It is not recommended for use in production environments. You can learn about the iteration plans on the [roadmap](https://univer.ai/guides/sheet/roadmap).
:::

## Usage
Expand Down
2 changes: 1 addition & 1 deletion packages/facade/README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

在 Univer 当中,除了使用底层的 API 之外,你还可以使用 `@univerjs/facade` 提供的 Facade API,它是对底层 API 的封装,更加简单易用。

你可以通过阅读[这篇文档](https://univer.ai/zh-cn/guides/facade/)了解如何使用 Facade API。
你可以通过阅读[这篇文档](https://univer.ai/zh-CN/guides/sheet/facade/facade/)了解如何使用 Facade API。

## 使用指南

Expand Down
2 changes: 1 addition & 1 deletion packages/facade/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

In Univer, in addition to using the low-level APIs, you can also use the Facade API provided by `@univerjs/facade`, which is a higher-level abstraction of the low-level APIs, making it easier to use.

You can learn how to use the Facade API by reading [this document](https://univer.ai/guides/facade/).
You can learn how to use the Facade API by reading [this document](https://univer.ai/guides/sheet/facade/facade/).

## Usage

Expand Down
4 changes: 2 additions & 2 deletions packages/facade/docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How to Contribute to Facade API

Facade API is an API layer of all other packages of Univer and it helps users to use Univer easily. For a detailed introduction of Facade API, please visit [Facade API](https://univer.ai/guides/facade).
Facade API is an API layer of all other packages of Univer and it helps users to use Univer easily. For a detailed introduction of Facade API, please visit [Facade API](https://univer.ai/guides/sheet/facade/facade).

## How to Contribute

Expand Down Expand Up @@ -33,4 +33,4 @@ export class FWorkbook {

## Documentation

It is strongly suggested to add documentation for your code [here](https://github.com/dream-num/univer.ai/tree/dev/packages/community/src/content/docs/guides/facade). Please refer to our [documentation repo](https://github.com/dream-num/docs) for more guidance.
It is strongly suggested to add documentation for your code [here](https://github.com/dream-num/univer.ai/tree/dev/packages/community/src/content/docs/guides/sheet/facade). Please refer to our [documentation repo](https://github.com/dream-num/docs) for more guidance.
2 changes: 1 addition & 1 deletion packages/rpc/README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

在处理一些比较耗时的任务——例如公式计算——时,Univer 可以将它们转移到主线程之外的地方进行,例如 Web Worker 线程中。@univerjs/rpc 提供了一套 RPC 机制,使得在主线程和其他线程之间进行通信变得简单。

详情请参考 [Web Worker 架构](https://univer.ai/zh-cn/guides/concepts-and-architecture/web-worker/)
详情请参考 [Web Worker 架构](https://univer.ai/zh-CN/guides/sheet/architecture/web-worker)

## 使用指南

Expand Down
2 changes: 1 addition & 1 deletion packages/rpc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

When handling some time-intensive tasks, such as formula computation, Univer can offload them to a location outside of the main thread, such as a Web Worker thread. The `@univerjs/rpc` library provides an RPC mechanism that simplifies communication between the main thread and other threads.

For more information, see the [Architecture of Web Worker](https://univer.ai/guides/concepts-and-architecture/web-worker/).
For more information, see the [Architecture of Web Worker](https://univer.ai/guides/sheet/architecture/web-worker).

## Usage

Expand Down
4 changes: 2 additions & 2 deletions packages/sheets-formula/README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ pnpm add @univerjs/sheets-formula

如果官方提供的公式不满足您的需求,可以自己扩展公式。根据不同的需求,我们提供了多种方式来支持注册一个或多个自定义公式。

- [使用 Facade API 注册公式](https://univer.ai/zh-cn/guides/facade/general/#注册公式)
- [自定义公式](https://univer.ai/zh-cn/guides/customization/formula/)
- [使用 Facade API 注册公式](https://univer.ai/zh-CN/guides/sheet/facade/general#%E6%B3%A8%E5%86%8C%E5%85%AC%E5%BC%8F)
- [自定义公式](https://univer.ai/zh-CN/guides/sheet/customization/formula/)

4 changes: 2 additions & 2 deletions packages/sheets-formula/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,5 @@ pnpm add @univerjs/sheets-formula

If the officially provided formula does not meet your needs, you can expand the formula yourself. Depending on different needs, we provide multiple ways to support registering one or more custom formulas.

- [Register formula using Facade API](https://univer.ai/guides/facade/general/#register-formula)
- [Custom Formula](https://univer.ai/guides/customization/formula/)
- [Register formula using Facade API](https://univer.ai/guides/sheet/facade/general/#register-formula)
- [Custom Formula](https://univer.ai/guides/sheet/customization/formula/)
2 changes: 1 addition & 1 deletion packages/sheets-numfmt/README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,5 @@ const univer = new Univer({
univer.registerPlugin(UniverSheetsNumfmtPlugin);
```
:::note
如果你需要导出快照支持导出数字格式,需要额外新增[一部分代码](/guides/extend/model/#本地化快照方案)
如果你需要导出快照支持导出数字格式,需要额外新增[一部分代码](https://univer.ai/guides/sheet/customization/model)
:::
4 changes: 2 additions & 2 deletions packages/uniscript/README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
用户可以在 @univerjs/uniscript 提供的代码编辑器中编写业务逻辑,以达成更加灵活的业务需求。如图所示,用户可以编写一段 Uniscript 用于从选区中读取身份证号并验证这些身份证号的合法性,把不合法的身份证号的背景标记为红色。

:::caution
Uniscript 仍在试验阶段,建议不要在生产环境中使用。你可以在[路线图](https://univer.ai/zh-cn/guides/introduction/roadmap/)了解 Uniscript 的迭代计划。
Uniscript 仍在试验阶段,建议不要在生产环境中使用。你可以在[路线图](https://univer.ai/zh-CN/guides/sheet/roadmap/)了解 Uniscript 的迭代计划。
:::

:::tip
Uniscript 的 DSL 实际上是一套封装 Univer 内部实现细节的 Facade API,这套 API 定义在[这里](https://univer.ai/guides/facade/)
Uniscript 的 DSL 实际上是一套封装 Univer 内部实现细节的 Facade API,这套 API 定义在[这里](https://univer.ai/guides/sheet/facade/facade)
:::

## 使用指南
Expand Down
4 changes: 2 additions & 2 deletions packages/uniscript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
Users can write business logic in the code editor to meet more flexible business requirements. For instance, as shown in the illustration, users can write a Uniscript to read identity card numbers from a selected area and validate their legality, and mark the background of invalid identity card numbers with red.

:::caution
The Uniscript is currently in the experimental stage, and it is not recommended to use it in production environments. You can refer to the [Roadmap](https://univer.ai/guides/introduction/roadmap/) to understand the iteration plan of Uniscript.
The Uniscript is currently in the experimental stage, and it is not recommended to use it in production environments. You can refer to the [Roadmap](https://univer.ai/guides/sheet/roadmap) to understand the iteration plan of Uniscript.
:::

:::tip
Indeed, Uniscript's Domain-Specific Language (DSL) is a set of Facade APIs that encapsulate the internal implementation details of Univer. This API is defined [here](https://univer.ai/guides/facade/).
Indeed, Uniscript's Domain-Specific Language (DSL) is a set of Facade APIs that encapsulate the internal implementation details of Univer. This API is defined [here](https://univer.ai/guides/sheet/facade/facade).
:::

## Usage
Expand Down

0 comments on commit 5f26e90

Please sign in to comment.