From 2aad09c64bfd65b28e6055ffc27c722a00a3f858 Mon Sep 17 00:00:00 2001 From: Chaoya Li Date: Wed, 3 Jul 2024 18:23:40 +0800 Subject: [PATCH 1/7] updated faq --- docs/start/faq.md | 91 +++++++++++++++++++++++------------------------ 1 file changed, 45 insertions(+), 46 deletions(-) diff --git a/docs/start/faq.md b/docs/start/faq.md index a108635..21c191a 100644 --- a/docs/start/faq.md +++ b/docs/start/faq.md @@ -7,81 +7,80 @@ sidebar_position: 2 ## What is VGG? -VGG, short for VeryGoodGraphics, is a next-gen vector graphics which focuses on the design -and development of cross-platform user interface. +VGG, short for VeryGoodGraphics, is next-gen vector graphics useful for the design and +development of cross-platform user interfaces. -VGG is so versatile that you can see it from at least two views: -- As a kind of vector graphics, it could be compared to SVG (Scalable Vector Graphics). -- As a cross-platform UI framework, it could be compared to Flutter. +VGG is so versatile that you can view it from at least two perspectives: +- As a type of vector graphics, it can be compared to SVG (Scalable Vector Graphics). +- As a cross-platform UI framework, it can be compared to Flutter. -You can take VGG a vectorized UI framework that use vector graphics heavily as general user -interfaces. +You can consider VGG a vectorized UI framework that uses vector graphics extensively for +general user interfaces. ## What problem is VGG going to solve? -The application development process, when involved with particularly UI design and -development, can be tedious, monotonous and low efficient. For example, +The application development process, particularly UI design and development, can be tedious, +monotonous, and inefficient. For example, -- There is a lot of unnecessary communication efforts between designers and developers. -- There is a lot of unnecessary work efforts for developers, the most annoying being - writing code to implement a UI to be pixel-perfectly the same as the design draft. +- There are many unnecessary communication efforts between designers and developers. +- There are many unnecessary efforts for developers, the most annoying being writing code to + make a UI pixel-perfectly match the design draft. -VGG tries to speed up this design & development process by eliminating those unnecessary +VGG aims to speed up this design and development process by eliminating those unnecessary efforts as much as possible. ## How does VGG solve this problem? -VGG solves this problem by providing Design-as-Code paradigm for UI development, that -lets programmers to use any design drafts as the starting point for UI building by -treating them as vector graphics resources. +VGG solves this problem by providing a Design-as-Code paradigm for UI development, allowing +programmers to use design drafts as the starting point for UI building by treating them as +vector graphics resources. -Meanwhile, VGG also tries to provide best cross-platform support, as well as design & development -ecosystem support so as to bring developers the best developer experience. +Meanwhile, VGG also aims to provide the best cross-platform support and design & development +ecosystem support to offer developers the best experience. ## What's the difference between VGG and HTML/CSS? -The UI design process and UI development process happens in two different levels of abstractions. -The design language is expressing low-level vector graphics elements, while the programming -language is expressing high-level UI concepts like components or widgets. +The UI design and development processes happen at two different levels of abstraction. The design +language expresses low-level vector graphics elements, while the programming language expresses +high-level UI concepts like components or widgets. -The common Design-to-Code process usually involves conversion from the low-level vector graphics to -a higher level of code. It is similar to a lossy compression process that not only loses some details -but also loses the control of converted details in higher level. +The common Design-to-Code process usually involves converting low-level vector graphics to higher-level +code. It is similar to a lossy compression process that loses some details and control of the converted +details at a higher level. -Since VGG is a kind of vector graphics, so the conversion from design to VGG is a lossless compression -process, which gives you back the full details as well as the control of these details. +Since VGG is a type of vector graphics, the conversion from design to VGG is a lossless process, +retaining full details and control. -And that's the most important discrepancy between VGG and HTML/CSS. +This is the most important difference between VGG and HTML/CSS. ## What's the difference between VGG and SVG? -SVG is a vector graphics that is based on XML, with many different implementations across different -platforms so some rendering effects are not the same on different platforms. And SVG also lacks some -graphic features, so the conversion result from design tools could be very poor. +SVG is vector graphics based on XML, with many different implementations across platforms, leading to +inconsistent rendering effects. SVG also lacks some graphic features, resulting in poor conversion +from design tools. -VGG is a next-gen vector graphics that is based on JSON, with an official cross-platform implementation -that has consistent rendering effects and behaviors on all platforms with the help of runtime wrappers -called VGG containers. VGG is also rich in graphic features that is good for conversion from common design -tools. +VGG is next-gen vector graphics based on JSON, with an official cross-platform implementation that ensures +consistent rendering effects and behaviors on all platforms using runtime wrappers called VGG containers. +VGG is also rich in graphic features, making it suitable for conversion from common design tools. -Say, if designers could export their design as a SVG that is perfect in rendering effects and consistent -across different platforms, the developers can just take it as the basis of further UI development, right? -However, it is not possible because of those intrinsic pitfalls of SVG. +If designers could export their designs as SVG with perfect rendering effects and consistency across +platforms, developers could use it as the basis for further UI development. However, this is not possible +due to the intrinsic pitfalls of SVG. -VGG solves the problems of SVG so the above workflow, called Design-as-Code by VGG, becomes a reality. +VGG solves SVG's problems, making the Design-as-Code workflow a reality. ## Is VGG free? -VGG comes with an open standard and an open source runtime which is licensed under a __conditionally -free__ VGG license. The only reason for non-totally-free is that VGG Group has contributed a lot -(over least two years) and simply doesn't want it stolen easily. If you don't like this license, you -are free and welcome to write a 3rd-party implementation. +VGG comes with an open standard and an open-source runtime licensed under a conditionally free VGG +license. The only reason it is not completely free is that VGG Group has contributed significantly +(over at least two years) and doesn't want it easily stolen. If you don't like this license, you +are free to write a third-party implementation. -In a word, you can take VGG runtime an almost-free product as VGG Group didn't expect to make profit -simply from this license, as SaaS and technical support are how we expected to make money. +In short, you can consider VGG an almost-free product, as VGG Group does not expect to profit solely +from this license, but rather from SaaS and technical support. ## So what's the condition of VGG license? -You shall pay VGG a 2% royalty if and only if your VGG-applied product makes more than 10000 USD -every quarter. +You must pay VGG a 2% royalty only if your VGG-applied product makes more than $10,000 every quarter. +You can read the full [VGG License](https://verygoodgraphics.com/licenses/LICENSE-latest) for more details. From df86c86412eaa9905e1977e9e628676b0723c64d Mon Sep 17 00:00:00 2001 From: Chaoya Li Date: Thu, 4 Jul 2024 18:14:04 +0800 Subject: [PATCH 2/7] added community overview and CRP --- docs/community/contribution-guide.md | 2 - docs/community/contributor-reward-program.md | 36 ++++++++++++++++++ docs/community/meetups.md | 2 +- docs/community/overview.md | 39 +++++++++++++++++++- docs/start/faq.md | 3 ++ docusaurus.config.js | 2 +- 6 files changed, 79 insertions(+), 5 deletions(-) create mode 100644 docs/community/contributor-reward-program.md diff --git a/docs/community/contribution-guide.md b/docs/community/contribution-guide.md index f709a8f..4c079cc 100644 --- a/docs/community/contribution-guide.md +++ b/docs/community/contribution-guide.md @@ -9,8 +9,6 @@ We welcome and appreciate your contributions in terms of bug fixes, enhancements Both core team members and external contributors send pull requests that undergo the same review process. Refer to [GitHub's pull request tutorial](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) if you encounter any issues. -Upon opening a pull request, you will be prompted to sign a [Contributor License Agreement (CLA)](https://raw.githubusercontent.com/verygoodgraphics/vgg_runtime/main/.github/CLA.md) by leaving a comment as instructed. - ### Basic PR Requirements - Keep each commit atomic, and commit with clear messages. diff --git a/docs/community/contributor-reward-program.md b/docs/community/contributor-reward-program.md new file mode 100644 index 0000000..913adc3 --- /dev/null +++ b/docs/community/contributor-reward-program.md @@ -0,0 +1,36 @@ +--- +title: Contributor Reward Program +sidebar_position: 3 +--- + +:::info[NOTE] +This program only applies to [VGG Runtime](https://github.com/verygoodgraphics/vgg_runtime) +::: + +:::warning +This program is a WIP and will be detailed in the future. The essence won't change regardless. +::: + +## Why do we need this program? + +VGG Runtime is open-sourced under a conditionally free [license](https://verygoodgraphics.com/licenses/LICENSE-latest), +which differs from common open-source licenses and may cause confusion for open-source contributors. Questions like "Am +I working for this commercial project for free?" or "Why do I have to contribute to this commercial project?" may arise. + +VGG Contributor Reward Program (CRP) addresses these concerns by sharing profits from the VGG License to well-recognized +VGG community contributors. + +## Who is enrolled in this program? + +By contributing to VGG Runtime (with at least one PR merged), you are automatically enrolled in this program. + +## What criteria must be met for the reward? + +You need to be recognized by VGG Group as a core contributor. VGG Group will make a fair judgment. + +## How much I can get? + +It depends. If zero profit is generated from VGG License, you'll get nothing substantial except for your public +contribution records. + +All royalty fees paied to VGG will be published online. diff --git a/docs/community/meetups.md b/docs/community/meetups.md index 1135b40..d042835 100644 --- a/docs/community/meetups.md +++ b/docs/community/meetups.md @@ -1,6 +1,6 @@ --- title: Meetups -sidebar_position: 6 +sidebar_position: 5 --- Coming soon! diff --git a/docs/community/overview.md b/docs/community/overview.md index 7ad9aff..319c3b9 100644 --- a/docs/community/overview.md +++ b/docs/community/overview.md @@ -4,5 +4,42 @@ sidebar_label: Overview sidebar_position: 0 --- -Coming soon! +VeryGoodGraphics (VGG) Community is devoted to facilitating the development and adoption of the +VGG Project, including VGG Specs, VGG Runtime, VGG Containers, and other VGG-related technologies. +VGG Community consists of different roles, including core members, contributors, and users. + +## As Core Members + +VGG Group is a group of people consisting of the core members of the VGG Project. You can learn +more from [VGG Goverance](/community/goverance). + +## As Contributors + +All developments happen in VGG's GitHub [organization](https://github.com/verygoodgraphics), where +VGG core members and contributors work on the VGG Project together. Any contributor should read the +following before making any contribution to the VGG Project. + +- [Contribution Guide](/community/contribution-guide) +- [Code of Conduct](/community/code-of-conduct) + +All VGG projects are open-sourced under the MIT license, except for VGG Runtime which is open-sourced +under a conditionally free license. There is an [Contributor Reward Program](/community/contributor-reward-program) +if you would like to contribute to the VGG Runtime. + +## As Users + +For newcomers willing to learn VGG framework, the following materials might be helpful: + +- [Quick Start](/start/overview) +- [FAQ](/start/faq) +- [Examples](examples/overview) + +If you are only interested in the vector graphics part, you can explore: + +- The open [specification](/specs/overview) +- Illustrations of each [feature](/features/overview) + +## Contacts + +Members of any role can communicate through the VGG [Discord channel](https://discord.gg/89fFapjfgM). Alternatively, you can follow VGG's [X (Twitter)](https://twitter.com/VGG_Design) account. diff --git a/docs/start/faq.md b/docs/start/faq.md index 21c191a..2d9ee7b 100644 --- a/docs/start/faq.md +++ b/docs/start/faq.md @@ -84,3 +84,6 @@ from this license, but rather from SaaS and technical support. You must pay VGG a 2% royalty only if your VGG-applied product makes more than $10,000 every quarter. You can read the full [VGG License](https://verygoodgraphics.com/licenses/LICENSE-latest) for more details. +## Who is behind VGG? + +VGG is initiated and developed by VGG Group. You can find the core members in the [VGG Goverance](/community/goverance) document. diff --git a/docusaurus.config.js b/docusaurus.config.js index d80998b..28ac540 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -151,7 +151,7 @@ const config = { ], }, { - title: "Community", + title: "Contacts", items: [ { label: "Discord", From 32e02d9199946ba5ffab3641ab593ad4d7848bfb Mon Sep 17 00:00:00 2001 From: Chaoya Li Date: Thu, 4 Jul 2024 18:47:22 +0800 Subject: [PATCH 3/7] added initial governance doc --- docs/community/goverance.md | 7 ------- docs/community/governance.md | 18 ++++++++++++++++++ docs/community/overview.md | 2 +- docs/start/faq.md | 2 +- 4 files changed, 20 insertions(+), 9 deletions(-) delete mode 100644 docs/community/goverance.md create mode 100644 docs/community/governance.md diff --git a/docs/community/goverance.md b/docs/community/goverance.md deleted file mode 100644 index ac5356f..0000000 --- a/docs/community/goverance.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: VGG Goverance -sidebar_label: Goverance -sidebar_position: 4 ---- - -Coming soon! diff --git a/docs/community/governance.md b/docs/community/governance.md new file mode 100644 index 0000000..4b7abc4 --- /dev/null +++ b/docs/community/governance.md @@ -0,0 +1,18 @@ +--- +title: VGG Governance +sidebar_label: Governance +sidebar_position: 4 +--- + +VGG Project is governed by VGG Group. + +## Core Members + +``` +Chaoya Li +Guanhua Hou +Shuoliu Yang +szn <80252484@qq.com> +MaybeMonad +elf +``` diff --git a/docs/community/overview.md b/docs/community/overview.md index 319c3b9..14968c8 100644 --- a/docs/community/overview.md +++ b/docs/community/overview.md @@ -12,7 +12,7 @@ VGG Community consists of different roles, including core members, contributors, ## As Core Members VGG Group is a group of people consisting of the core members of the VGG Project. You can learn -more from [VGG Goverance](/community/goverance). +more from [VGG Governance](/community/governance). ## As Contributors diff --git a/docs/start/faq.md b/docs/start/faq.md index 2d9ee7b..e0e58c9 100644 --- a/docs/start/faq.md +++ b/docs/start/faq.md @@ -86,4 +86,4 @@ You can read the full [VGG License](https://verygoodgraphics.com/licenses/LICENS ## Who is behind VGG? -VGG is initiated and developed by VGG Group. You can find the core members in the [VGG Goverance](/community/goverance) document. +VGG is initiated and developed by VGG Group. You can find the core members in the [VGG Governance](/community/governance) document. From 4a9d5cf6a3f92d9d1c697930c140e9a856cc59b0 Mon Sep 17 00:00:00 2001 From: Chaoya Li Date: Fri, 5 Jul 2024 11:31:35 +0800 Subject: [PATCH 4/7] updated member name --- docs/community/governance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/community/governance.md b/docs/community/governance.md index 4b7abc4..8c6d190 100644 --- a/docs/community/governance.md +++ b/docs/community/governance.md @@ -14,5 +14,5 @@ Guanhua Hou Shuoliu Yang szn <80252484@qq.com> MaybeMonad -elf +Elvin Zhao ``` From 3dfdb7a033edffbdf20f25ffe5144001688177d3 Mon Sep 17 00:00:00 2001 From: Chaoya Li Date: Fri, 5 Jul 2024 11:43:29 +0800 Subject: [PATCH 5/7] updated community overview --- docs/community/overview.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/community/overview.md b/docs/community/overview.md index 14968c8..6589d66 100644 --- a/docs/community/overview.md +++ b/docs/community/overview.md @@ -4,17 +4,24 @@ sidebar_label: Overview sidebar_position: 0 --- -VeryGoodGraphics (VGG) Community is devoted to facilitating the development and adoption of the -VGG Project, including VGG Specs, VGG Runtime, VGG Containers, and other VGG-related technologies. +## Mission + +The mission of VGG Project aims to provide next-gen vector graphics and related tools and apps, +including an embeddable cross-platform UI framework. + +While VGG Community is devoted to facilitating the development and adoption of the VGG Project, +including VGG Specs, VGG Runtime, VGG Containers, and other VGG-related technologies. + +## Roles VGG Community consists of different roles, including core members, contributors, and users. -## As Core Members +### As Core Members VGG Group is a group of people consisting of the core members of the VGG Project. You can learn more from [VGG Governance](/community/governance). -## As Contributors +### As Contributors All developments happen in VGG's GitHub [organization](https://github.com/verygoodgraphics), where VGG core members and contributors work on the VGG Project together. Any contributor should read the @@ -27,7 +34,7 @@ All VGG projects are open-sourced under the MIT license, except for VGG Runtime under a conditionally free license. There is an [Contributor Reward Program](/community/contributor-reward-program) if you would like to contribute to the VGG Runtime. -## As Users +### As Users For newcomers willing to learn VGG framework, the following materials might be helpful: From 472c161acdc4ca3d3b1ed3fc01eaaf4d44153179 Mon Sep 17 00:00:00 2001 From: Chaoya Li Date: Fri, 5 Jul 2024 11:43:43 +0800 Subject: [PATCH 6/7] fixed github workflow --- .github/workflows/deploy.yml | 2 +- .github/workflows/test-deploy.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index d6204e9..c01a394 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -22,7 +22,7 @@ jobs: - name: Prepare source code uses: actions/checkout@v3 - - uses: pnpm/action-setup@v2 + - uses: pnpm/action-setup@v4 with: version: 8 diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml index 5650e5b..1cc417c 100644 --- a/.github/workflows/test-deploy.yml +++ b/.github/workflows/test-deploy.yml @@ -19,7 +19,7 @@ jobs: - name: Prepare source code uses: actions/checkout@v3 - - uses: pnpm/action-setup@v2 + - uses: pnpm/action-setup@v4 with: version: 8 From 4e07bb87d8ccc9e46358cc03c28c6469a504687c Mon Sep 17 00:00:00 2001 From: Chaoya Li Date: Fri, 5 Jul 2024 11:49:47 +0800 Subject: [PATCH 7/7] fixed broken link --- docs/community/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/community/overview.md b/docs/community/overview.md index 6589d66..9f6fa71 100644 --- a/docs/community/overview.md +++ b/docs/community/overview.md @@ -40,7 +40,7 @@ For newcomers willing to learn VGG framework, the following materials might be h - [Quick Start](/start/overview) - [FAQ](/start/faq) -- [Examples](examples/overview) +- [Examples](/examples/overview) If you are only interested in the vector graphics part, you can explore: