docs(ribir): ✏️ update changelog & readme

RibirX · Dec 27, 2023 · 20e170e · 20e170e
1 parent 94db951
commit 20e170e
Show file tree

Hide file tree

Showing 12 changed files with 14 additions and 51 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,7 +12,7 @@ There are 5 types of changes:
 - `Documented` for any changes to the documentation.
 - `Breaking` for the detail of any backward incompatible changes.
 
-And please only add new entries below the [Unreleased](#unreleased---releasedate) header with the following format:
+Please only add new entries below the [Unreleased](#unreleased---releasedate) header with the following format:
 
 ```md
 **crate or effect scope**: description of change (#PR @contributor)
@@ -24,11 +24,13 @@ And please only add new entries below the [Unreleased](#unreleased---releasedate
 
 🎉🎉🎉 The first version of Ribir. 
 
-![background](https://not.ready/demos.png)
+![background](./docs/assets/hero-banner.png)
 
-As the first version, its main content is to verify and stabilize the basic concepts, determine the overall framework process, and make preliminary attempts to verify all core modules. 
+The goal of this version of Ribir is to finish the core framework and answer our questions about the feasibility of the design.
 
-We use it in our own projects and have a good experience, and we hope you can also try it out and give us feedback. But it is still in a very rough stage, and be careful to use it in production.
+We use it to build examples and build some apps for our daily work. And we are satisfied with the experience of using it.
+
+We are very happy to share it with you. We hope you can try it out and give us feedback. But we don't recommend you to use it in production environments yet.
 
 ### Features
 
@@ -51,7 +53,7 @@ We use it in our own projects and have a good experience, and we hope you can al
 
 ### Documented
 
-- **introduction**: add `introduction.md` to introduce Ribir and why choose it.
+- **introduction**: add `introduction.md` to introduce Ribir and why chose it.
 - **get started**: add the `get_started` series of tutorials to help users get started with Ribir.
 
 

diff --git a/README.md b/README.md
@@ -17,9 +17,10 @@ Use Rust to build multi-platform applications from a single codebase.
 
 [Website] | [Documents] | [Examples] | [Changelog]
 
-<!--todo: a demos picture here-->
 </div>
 
+![](./docs/assets/hero-banner.png)
+
 ## What's Ribir?
 
 Ribir is a Rust GUI framework that helps you build beautiful and native multi-platform applications from a single codebase.
@@ -64,7 +65,6 @@ fn main() {
 
 More [Examples]
 
-
 ## Features
 
 - **Declarative language** does not introduce a fully new language but rather provides a set of Rust macros for easy interaction.
@@ -82,6 +82,10 @@ More [Examples]
 - **Text** support basic text typography and IME input, in a usable but rough stage.
 - **Widgets** library provides 20+ basic widgets, but all are in a rough stage, and the API is not stable yet.
 
+## Architecture overview
+
+![](./docs/assets/architecture.svg)
+
 ## Support Platform 
 
 |Platform|Support situation|

diff --git a/docs/advanced_topics/_category_.json b/docs/advanced_topics/_category_.json
diff --git a/docs/advanced_topics/architecture.md b/docs/advanced_topics/architecture.md
diff --git a/docs/assets/architecture.svg b/docs/assets/architecture.svg
diff --git a/docs/assets/hero-banner.png b/docs/assets/hero-banner.png
diff --git a/docs/essentials/_category_.json b/docs/essentials/_category_.json
diff --git a/docs/essentials/application_theme.md b/docs/essentials/application_theme.md
diff --git a/docs/essentials/understand_ribir.md b/docs/essentials/understand_ribir.md
diff --git a/docs/project_practice/_category_.json b/docs/project_practice/_category_.json
diff --git a/docs/project_practice/img/todo_example.png b/docs/project_practice/img/todo_example.png
diff --git a/docs/project_practice/more_example.md b/docs/project_practice/more_example.md