fix(docs): fix broken links in ./lvgl/README.md (lvgl#7146)

OS-Q · Oct 28, 2024 · 868db01 · 868db01
1 parent befbe81
commit 868db01
Show file tree

Hide file tree

Showing 5 changed files with 202 additions and 43 deletions.
diff --git a/README.md b/README.md
@@ -50,25 +50,25 @@ Our team is ready to help you with graphics design, UI implementation and consul
   - OS, External memory and GPU are supported but not required.
 
 **Widgets, Styles, Layouts and more**
-  - 30+ built-in [Widgets](https://docs.lvgl.io/master/widgets/index.html):  Button, Label, Slider, Chart, Keyboard, Meter, Arc, Table and many more.
-  - Flexible [Style system](https://docs.lvgl.io/master/overview/style.html) with  ~100 style properties to customize any part of the widgets in any state.
-  - [Flexbox](https://docs.lvgl.io/master/layouts/flex.html) and [Grid](https://docs.lvgl.io/master/layouts/grid.html)-like layouts engines to automatically size and position the widgets in a responsive way.
+  - 30+ built-in [Widgets](https://docs.lvgl.io/master/details/widgets/index.html):  Button, Label, Slider, Chart, Keyboard, Meter, Arc, Table and many more.
+  - Flexible [Style system](https://docs.lvgl.io/master/details/base-widget/styles/style.html) with  ~100 style properties to customize any part of the widgets in any state.
+  - [Flexbox](https://docs.lvgl.io/master/details/base-widget/layouts/flex.html) and [Grid](https://docs.lvgl.io/master/details/base-widget/layouts/grid.html)-like layouts engines to automatically size and position the widgets in a responsive way.
   - Texts are rendered with UTF-8 encoding supporting CJK, Thai, Hindi, Arabic, Persian writing systems.
   - Word wrapping, kerning, text scrolling, sub-pixel rendering, Pinyin-IME Chinese input, Emojis in texts.
   - Rendering engine supporting animations, anti-aliasing, opacity, smooth scrolling, shadows, image transformation, etc  
-  - Supports Mouse, Touchpad, Keypad, Keyboard, External buttons, Encoder [Input devices](https://docs.lvgl.io/master/porting/indev.html).
-  - [Multiple display](https://docs.lvgl.io/master/overview/display.html#multiple-display-support) support.
+  - Supports Mouse, Touchpad, Keypad, Keyboard, External buttons, Encoder [Input devices](https://docs.lvgl.io/master/details/main-components/indev.html).
+  - [Multiple display](https://docs.lvgl.io/master/details/main-components/display.html#how-many-displays-can-lvgl-use) support.
 
 **Binding and Build Support**
   - [MicroPython Binding](https://blog.lvgl.io/2019-02-20/micropython-bindings) exposes LVGL API
   - [PikaScript Binding](https://blog.lvgl.io/2022-08-24/pikascript-and-lvgl) python on MCU lighter and easier.
   - No custom build system is used. You can build LVGL as you build the other files of your project.
-  - Support for Make and [CMake](https://docs.lvgl.io/master/integration/building/cmake.html) is included out of the box.
-  - [Develop on PC](https://docs.lvgl.io/master/integration/ide/pc-simulator.html) and use the same UI code on embedded hardware.
+  - Support for Make and [CMake](https://docs.lvgl.io/master/details/integration/building/cmake.html) is included out of the box.
+  - [Develop on PC](https://docs.lvgl.io/master/details/integration/ide/pc-simulator.html) and use the same UI code on embedded hardware.
   - Convert the C UI code to HTML file with our [Emscripten port](https://github.com/lvgl/lv_web_emscripten).
 
 **Docs, Tools, and Services**
-  - Detailed [Documentation](https://docs.lvgl.io/) with [100+ simple examples](https://docs.lvgl.io/master/index.html)
+  - Detailed [Documentation](https://docs.lvgl.io/) with [100+ simple examples](https://docs.lvgl.io/master/examples.html)
   - [Services](https://lvgl.io/services) such as User interface design, Implementation and Consulting to make UI development simpler and faster.
 
 ## :heart: Sponsor
@@ -92,13 +92,13 @@ If someone implements or fixes an issue labeled as [Sponsored](https://github.co
 
 ## :package: Packages
 LVGL is available as:
-- [Arduino library](https://docs.lvgl.io/master/integration/framework/arduino.html)
+- [Arduino library](https://docs.lvgl.io/master/details/integration/framework/arduino.html)
 - [PlatformIO package](https://registry.platformio.org/libraries/lvgl/lvgl)
-- [Zephyr library](https://docs.lvgl.io/master/integration/os/zephyr.html)
+- [Zephyr library](https://docs.lvgl.io/master/details/integration/os/zephyr.html)
 - [ESP-IDF(ESP32) component](https://components.espressif.com/components/lvgl/lvgl)
 - [NXP MCUXpresso component](https://www.nxp.com/design/software/embedded-software/lvgl-open-source-graphics-library:LITTLEVGL-OPEN-SOURCE-GRAPHICS-LIBRARY)
-- [NuttX library](https://docs.lvgl.io/master/integration/os/nuttx.html)
-- [RT-Thread RTOS](https://docs.lvgl.io/master/integration/os/rt-thread.html)
+- [NuttX library](https://docs.lvgl.io/master/details/integration/os/nuttx.html)
+- [RT-Thread RTOS](https://docs.lvgl.io/master/details/integration/os/rt-thread.html)
 - CMSIS-Pack
 - [RIOT OS package](https://doc.riot-os.org/group__pkg__lvgl.html#details)
 
@@ -419,20 +419,20 @@ This list will guide you to get started with LVGL step-by-step.
 
 **Get Familiar with LVGL**
 
-  1. Check the [Online demos](https://lvgl.io/demos) to see LVGL in action (3 minutes)
-  2. Read the [Introduction](https://docs.lvgl.io/master/intro/index.html) page of the documentation (5 minutes)
-  3. Get familiar with the basics on the [Quick overview](https://docs.lvgl.io/master/get-started/quick-overview.html) page (15 minutes)
+  1. Check the [Online demos](https://lvgl.io/demos) to see LVGL in action (3 minutes).
+  2. Read the [Introduction](https://docs.lvgl.io/master/intro/index.html) page of the documentation (5 minutes).
+  3. Get familiar with the basics on the [Quick overview](https://docs.lvgl.io/master/intro/basics.html) page (15 minutes).
 
 **Start to Use LVGL**
 
-  4. Set up a [Simulator](https://docs.lvgl.io/master/integration/ide/pc-simulator.html#simulator) (10 minutes)
-  5. Try out some [Examples](https://github.com/lvgl/lvgl/tree/master/examples)
-  6. Port LVGL to a board. See the [Porting](https://docs.lvgl.io/master/porting/index.html) guide or check the ready to use [Projects](https://github.com/lvgl?q=lv_port_)
+  4. Set up a [Simulator](https://docs.lvgl.io/master/details/integration/ide/pc-simulator.html#simulator) (10 minutes).
+  5. Try out some [Examples](https://github.com/lvgl/lvgl/tree/master/examples).
+  6. Port LVGL to a board. See the [Porting](https://docs.lvgl.io/master/intro/add-lvgl-to-your-project/index.html) guide or check out the ready-to-use [Projects](https://github.com/lvgl?q=lv_port_).
 
 **Become a Pro**
 
-  7. Read the [Overview](https://docs.lvgl.io/master/overview/index.html) page to get a better understanding of the library (2-3 hours)
-  8. Check the documentation of the [Widgets](https://docs.lvgl.io/master/widgets/index.html) to see their features and usage
+  7. Read the [Main-Components](https://docs.lvgl.io/master/details/main-components/index.html) page to get a better understanding of the library (2-3 hours)
+  8. Check the documentation of the [Widgets](https://docs.lvgl.io/master/details/widgets/index.html) to see their features and usage
 
 **Get Help and Help Others**
 

diff --git a/docs/README_jp.rst b/docs/README_jp.rst
@@ -75,7 +75,7 @@ Cライブラリ。(C++互換) -
 任意の(RT)OS、任意のMCU・MPU用にコンパイル可能。 -
 電子ペーパー、OLEDディスプレイ、TFTディスプレイ、白黒ディスプレイ、モニターに対応。
 `Porting
-Guide <https://docs-lvgl-io.translate.goog/master/intro/add-lvgl-to-your-project/project.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja>`__
+Guide <https://docs-lvgl-io.translate.goog/master/intro/add-lvgl-to-your-project/connecting_lvgl.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja>`__
 - MITライセンスにより商用利用可能。 - システム要件：RAM 32KB、Flash
 128KB、フレームバッファ、レンダリング用に1/10以上のスクリーンサイズのバッファ。
 - OS、外部メモリ、GPUもサポート。
@@ -98,9 +98,9 @@ Guide <https://docs-lvgl-io.translate.goog/master/intro/add-lvgl-to-your-project
 アニメーション、アンチエイリアシング、不透明度、スムーズスクロール、シャドウ、画像変換などをサポートするレンダリングエンジン。
 -
 マウス、タッチパッド、キーパッド、キーボード、外部ボタン、エンコーダ等の
-`入力デバイス <https://docs-lvgl-io.translate.goog/master/details/modules/indev.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja>`__
+`入力デバイス <https://docs-lvgl-io.translate.goog/master/details/main-components/indev.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja>`__
 をサポート。 -
-`マルチディスプレイ <https://docs-lvgl-io.translate.goog/master/details/modules/display.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja>`__
+`マルチディスプレイ <https://docs-lvgl-io.translate.goog/master/details/main-components/display.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja>`__
 対応。
 
 **Binding と Build をサポート** - `MicroPython
@@ -556,7 +556,7 @@ LVGLを使い始める時は、以下の順に進める事をおすすめしま
    `Introduction <https://docs-lvgl-io.translate.goog/master/intro/index.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja>`__
    を読みましょう。 (5分間)
 3. LVGLの基本に慣れるため `Quick
-   overview <https://docs-lvgl-io.translate.goog/master/intro/overview.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja>`__
+   overview <https://docs-lvgl-io.translate.goog/master/intro/basics.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja>`__
    を読みましょう。 (15分間)
 
 **LVGLを使ってみましょう**
@@ -573,7 +573,7 @@ LVGLを使い始める時は、以下の順に進める事をおすすめしま
 **より詳しく体験してみましょう**
 
 7. ライブラリの理解を深めるため
-   `Overview <https://docs-lvgl-io.translate.goog/master/details/modules/index.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja>`__
+   `Overview <https://docs-lvgl-io.translate.goog/master/details/main-components/index.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja>`__
    を読みましょう。 (2～3時間)
 8. ウィジェットの機能や使い方の詳細は
    `Widgets <https://docs-lvgl-io.translate.goog/master/details/widgets/index.html?_x_tr_sl=en&_x_tr_tl=ja&_x_tr_hl=ja>`__

diff --git a/docs/README_pt_BR.rst b/docs/README_pt_BR.rst
@@ -88,8 +88,8 @@ algum suporte durante o desenvolvimento de seu próximo projeto de GUI.
    dependências externas.
 -  Pode ser compilado para qualquer display MCU ou MPU, e qualquer
    sistema operacional de tempo real (RT-OS).
--  Suporta monitores monocromáticos, ePaper, OLED ou TFT. :ref:`Guia de
-   portabilidade <initializing_lvgl>`
+-  Suporta monitores monocromáticos, ePaper, OLED ou TFT. `Guia de
+   portabilidade <https://docs.lvgl.io/master/intro/add-lvgl-to-your-project/connecting_lvgl.html>`__
 -  Distribuído sob a licença do MIT, para que você também possa usá-lo
    facilmente em projetos comerciais.
 -  Precisa de apenas 32 kB de RAM e 128 kB de Flash, um frame buffer e
@@ -126,7 +126,7 @@ algum suporte durante o desenvolvimento de seu próximo projeto de GUI.
 -  Nenhum sistema de compilação personalizado é usado. Você pode
    construir o LVGL enquanto constrói os outros arquivos do seu projeto.
 -  O suporte para Make e
-   :ref:`CMake <build_cmake>`
+   `CMake <https://docs.lvgl.io/master/details/integration/building/cmake.html>`__
    já vem incluído.
 -  `Desenvolva no
    PC <https://docs.lvgl.io/master/details/integration/ide/pc-simulator.html>`__
@@ -614,7 +614,7 @@ Esta lista irá guiá-lo para começar com o LVGL passo a passo.
    `introdução <https://docs.lvgl.io/master/intro/index.html>`__ da
    documentação (~5 minutos)
 3. Familiarize-se com o básico na página de `visão geral
-   rápida <https://docs.lvgl.io/master/intro/overview.html>`__
+   rápida <https://docs.lvgl.io/master/intro/basics.html>`__
    (~15 minutos)
 
 **Começando a usar o LVGL**
@@ -632,7 +632,7 @@ Esta lista irá guiá-lo para começar com o LVGL passo a passo.
 **Torne-se um profissional**
 
 7. Leia a página `visão
-   geral <https://docs.lvgl.io/master/details/modules/index.html>`__ para
+   geral <https://docs.lvgl.io/master/details/main-components/index.html>`__ para
    entender melhor a biblioteca (~2-3 horas)
 8. Verifique a documentação dos
    `widgets <https://docs.lvgl.io/master/details/widgets/index.html>`__ para ver

diff --git a/docs/README_zh.rst b/docs/README_zh.rst
@@ -72,7 +72,7 @@ RAM 和 128 KB Flash、C 编译器、帧缓冲区和至少 1/10 屏幕大小的
 -  一个完全可移植的 C（C++ 兼容）库，没有外部依赖关系。
 -  可以编译到任何 MCU 或 MPU，使用任何 RTOS 或者操作系统。
 -  支持单色、ePaper、OLED、TFT 显示器或者模拟器。
-   `移植指南 <https://docs.lvgl.io/master/intro/add-lvgl-to-your-project/project.html>`__
+   `移植指南 <https://docs.lvgl.io/master/intro/add-lvgl-to-your-project/connecting_lvgl.html>`__
 -  该项目使用 MIT 许可证，因此您可以在商业项目中轻松使用它。
 -  仅需 32 KB RAM 和 128 KB Flash，一个帧缓冲区，以及至少 1/10 屏幕大小的渲染缓冲区。
 -  支持使用可选的操作系统、外部存储器和 GPU。
@@ -89,8 +89,8 @@ RAM 和 128 KB Flash、C 编译器、帧缓冲区和至少 1/10 屏幕大小的
 -  文本支持 UTF-8 编码，支持 CJK、泰语、印地语、阿拉伯语和波斯语书写系统。
 -  支持自动换行、字距调整、文本滚动、亚像素渲染、拼音输入法、文本表情符号。
 -  渲染引擎支持动画、抗锯齿、不透明度、平滑滚动、阴影、图形变换等。
--  支持鼠标、触摸板、小键盘、键盘、外部按钮、编码器\ `输入设备 <https://docs.lvgl.io/master/details/modules/indev.html>`__\ 。
--  支持\ `多显示器 <https://docs.lvgl.io/master/details/modules/display.html#multiple-display-support>`__\ 。
+-  支持鼠标、触摸板、小键盘、键盘、外部按钮、编码器\ `输入设备 <https://docs.lvgl.io/master/details/main-components/indev.html>`__\ 。
+-  支持\ `多显示器 <https://docs.lvgl.io/master/details/main-components/display.html#multiple-display-support>`__\ 。
 
 **绑定和构建支持**
 
@@ -540,7 +540,7 @@ Hello world 标签
 
 1. 查看\ `在线演示 <https://lvgl.io/demos>`__\ ，了解 LVGL 的实际操作（3 分钟）
 2. 阅读\ `文档 <https://docs.lvgl.io/master/intro/index.html>`__\ 的简介页（5 分钟）
-3. 熟悉\ `快速概览 <https://docs.lvgl.io/master/intro/overview.html>`__
+3. 熟悉\ `快速概览 <https://docs.lvgl.io/master/intro/basics.html>`__
    页面上的基本知识（15 分钟）
 
 **开始使用 LVGL**
@@ -551,7 +551,7 @@ Hello world 标签
 
 **成为专业人士**
 
-7. 阅读\ `概述 <https://docs.lvgl.io/master/details/modules/index.html>`__\ 页面以更好地了解图书馆（2-3 小时）
+7. 阅读\ `概述 <https://docs.lvgl.io/master/details/main-components/index.html>`__\ 页面以更好地了解图书馆（2-3 小时）
 8. 查看\ `控件 <https://docs.lvgl.io/master/details/widgets/index.html>`__\ 的文档以查看其功能和用法
 
 **获得帮助并帮助他人**