Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature update community #52

Merged
merged 7 commits into from
Jul 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 0 additions & 2 deletions docs/community/contribution-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
36 changes: 36 additions & 0 deletions docs/community/contributor-reward-program.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 0 additions & 7 deletions docs/community/goverance.md

This file was deleted.

18 changes: 18 additions & 0 deletions docs/community/governance.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: VGG Governance
sidebar_label: Governance
sidebar_position: 4
---

VGG Project is governed by VGG Group.

## Core Members

```
Chaoya Li <harry75369@gmail.com>
Guanhua Hou <gaimanjing@gmail.com>
Shuoliu Yang <visysl@outlook.com>
szn <80252484@qq.com>
MaybeMonad <dezineleo@gmail.com>
Elvin Zhao <elvin.zhao@outlook.com>
```
2 changes: 1 addition & 1 deletion docs/community/meetups.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Meetups
sidebar_position: 6
sidebar_position: 5
---

Coming soon!
46 changes: 45 additions & 1 deletion docs/community/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,49 @@ sidebar_label: Overview
sidebar_position: 0
---

Coming soon!
## 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

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

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.
94 changes: 48 additions & 46 deletions docs/start/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,81 +7,83 @@ 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.

## Who is behind VGG?

VGG is initiated and developed by VGG Group. You can find the core members in the [VGG Governance](/community/governance) document.
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ const config = {
],
},
{
title: "Community",
title: "Contacts",
items: [
{
label: "Discord",
Expand Down
Loading