docs(ribir): ✏️ update readme #499

M-Adoo · 2023-12-08T02:44:36Z

No description provided.

thinkingjimmy · 2023-12-08T02:53:26Z

README.md

- **Declarative**: The user interface is the description of data, the description will automatically react to the data modification. Once you describe your data, the description will keep describing your data.
-
- **Purely composed**: Ribir creates UI via widgets. There is not a base-object, even if the built-in fields are provided in a composed way. For example,  only if you use `margin` field, the `Margin` widget will be composed, if you do not use it, you don't pay any overhead for `Margin`. "Only pay for what you need" is an important guideline for Ribir.
+Ribir is a Rust GUI framework to help you build beautiful, natively compiled, multi-platform applications from a single codebase.


少了个 open source

在仓库的首页就不必说开源了。

README.md

thinkingjimmy · 2023-12-08T03:28:22Z

docs/en/introduction.md

@@ -4,7 +4,7 @@

 ## What is Ribir?

-Ribir is an open source Rust framework for building beautiful UI, natively compiled, multi-platform applications from a single codebase.
+Ribir is an open-source Rust framework for building beautiful UI, natively compiled, multi-platform applications from a single codebase.



感觉这个 Introduction 跟 readme 有点重复，但内容好像又有点区别？

Introduction 里有写三大特色，但 Readme 里除了提到这三大特性外，还展开写了很多特性，比如 theme system ，Readme 是不是应该写简洁点只提三大特性？然后留个 More Features 的 Introduction 的链接后面，或者单独搞个文档，把所有 feature 都列出来。

另外，Introduction 里的 What is the current status of Ribir? 部分我觉得应该加到 Readme 里

感觉这个 Introduction 跟 readme 有点重复，但内容好像又有点区别？

Introduction 里有写三大特色，但 Readme 里除了提到这三大特性外，还展开写了很多特性，比如 theme system ，Readme 是不是应该写简洁点只提三大特性？然后留个 More Features 的 Introduction 的链接后面，或者单独搞个文档，把所有 feature 都列出来。

Introduction 偏概念和整体上介绍， readme 更面向仓库和代码，所以这里将核心 feature 都列出来，方便快速理解仓库具体有哪些能力和模块。

codecov · 2023-12-08T07:36:44Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4b82114) 85.14% compared to head (02fa8fc) 85.27%.
Report is 6 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #499      +/-   ##
==========================================
+ Coverage   85.14%   85.27%   +0.12%     
==========================================
  Files         177      178       +1     
  Lines       24382    24766     +384     
==========================================
+ Hits        20761    21119     +358     
- Misses       3621     3647      +26

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

M-Adoo · 2023-12-19T12:14:12Z

README.md

-</div>
+    </td>
+      <td style="padding:10px">
+        <img src="website/static/img/counter_demo.gif" width="300"/>


code and image not match

README.md

thinkingjimmy · 2023-12-20T08:33:57Z

README.md


 More [Examples]


-## Key Features
+## Features


下面的 feature 首字母应该大写

另外就是每句话都少了主语。按照之前写的 Key Features 形式写，语法上会更好一些。也比较清晰。

thinkingjimmy · 2023-12-20T09:00:43Z

README.md

+
+## Known Issues
+
+The most important issue we are facing is that `pipe/watch` may easily introduce a cycle reference, which will cause a memory leak. We'll resolve this issue in `v0.2.0`, and then, in most cases, the framework will be able to avoid cycle reference automatically, documentation will be updated to explain how to avoid cycle reference in the rest cases, and a good API will be provided to help developers resolve it.


The pipe/watch may easily introduce a cycle reference, which will cause a memory leak. We'll resolve this issue in v0.2.0.

In most cases, the framework will be able to avoid cycle reference automatically. Documentation will be updated to explain how to avoid cycle reference in the rest cases, and we will provide an API to help developers to resolve it.

sologeek · 2023-12-21T04:57:21Z

CHANGELOG.md

-
+- **layout system**: learning and inspired by [Flutter] Sublinear layout, but not the same.
+- **event system**: a composition event system, that supports event bubbling and capture. Allow to compose with any widget, and exists only if you use it.
+- **theme System**: support full and inherit/partial theme, so you can use it to override or dynamically switch the theme of the subtree. Include palette, icons, animate transitions, the decoration widget of the widget, etc. In a very rough state and the API will be redesigned soon.


typos: theme System -> theme system

README.md

sologeek · 2023-12-21T05:19:30Z

README.md


+A new way to build UI directly based on the API of your data, and every modification of data will drive the UI update point-to-point. You can focus on designing the data structure and API of your application, and then describe the UI of your data without intrusive its logic.


[translate suggestion]

A new way to build UI directly based on your data structure APIs, and all mutations of data will trigger the UI update by point to point. You need to focus on designing your data structure and API of your application only, and then describe the UI of your data by Ribir without intrusive its logic.

I updated it, you can take a look

M-Adoo force-pushed the docs/readme branch from c413561 to 64b31c9 Compare December 8, 2023 03:19

thinkingjimmy reviewed Dec 8, 2023

View reviewed changes

M-Adoo force-pushed the docs/readme branch 9 times, most recently from 9d4b00e to 9f122a0 Compare December 8, 2023 07:35

M-Adoo force-pushed the docs/readme branch 3 times, most recently from f446cbc to 841d526 Compare December 8, 2023 07:49

M-Adoo enabled auto-merge December 18, 2023 02:31

M-Adoo commented Dec 19, 2023

View reviewed changes

wjian23 reviewed Dec 19, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

wjian23 reviewed Dec 19, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

M-Adoo force-pushed the docs/readme branch 2 times, most recently from 35c1f00 to c62d042 Compare December 20, 2023 08:59

thinkingjimmy reviewed Dec 20, 2023

View reviewed changes

M-Adoo force-pushed the docs/readme branch from c62d042 to 5b2cdfd Compare December 20, 2023 10:13

sologeek reviewed Dec 21, 2023

View reviewed changes

docs(ribir): ✏️ update readme

02fa8fc

M-Adoo force-pushed the docs/readme branch from 5b2cdfd to 02fa8fc Compare December 21, 2023 08:11

sologeek approved these changes Dec 22, 2023

View reviewed changes

wjian23 approved these changes Dec 22, 2023

View reviewed changes

M-Adoo added this pull request to the merge queue Dec 22, 2023

Merged via the queue into master with commit 01724df Dec 22, 2023
7 checks passed

M-Adoo deleted the docs/readme branch December 22, 2023 06:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(ribir): ✏️ update readme #499

docs(ribir): ✏️ update readme #499

M-Adoo commented Dec 8, 2023

thinkingjimmy Dec 8, 2023

M-Adoo Dec 20, 2023

thinkingjimmy Dec 8, 2023

thinkingjimmy Dec 8, 2023

M-Adoo Dec 20, 2023

codecov bot commented Dec 8, 2023 •

edited

Loading

M-Adoo Dec 19, 2023

thinkingjimmy Dec 20, 2023

thinkingjimmy Dec 20, 2023

thinkingjimmy Dec 20, 2023

sologeek Dec 21, 2023

sologeek Dec 21, 2023

M-Adoo Dec 21, 2023


		## Known Issues

		The most important issue we are facing is that `pipe/watch` may easily introduce a cycle reference, which will cause a memory leak. We'll resolve this issue in `v0.2.0`, and then, in most cases, the framework will be able to avoid cycle reference automatically, documentation will be updated to explain how to avoid cycle reference in the rest cases, and a good API will be provided to help developers resolve it.


		A new way to build UI directly based on the API of your data, and every modification of data will drive the UI update point-to-point. You can focus on designing the data structure and API of your application, and then describe the UI of your data without intrusive its logic.

docs(ribir): ✏️ update readme #499

docs(ribir): ✏️ update readme #499

Conversation

M-Adoo commented Dec 8, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Dec 8, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Dec 8, 2023 •

edited

Loading